Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate setup.py docs, make docs in meson build #2853

Merged
merged 1 commit into from
May 25, 2024

Conversation

ankith26
Copy link
Member

@ankith26 ankith26 commented May 13, 2024

This is another small step in our move away from setup.py.

python setup.py docs internally executes python buildconfig/makeref.py, so this PR makes the straightforward replacement.

Also, another change that this PR makes is that it adds an invocation of above into the meson build itself. This makes the build process further streamlined under one command.

Should also help fix the fails in #2850

@ankith26 ankith26 requested a review from a team as a code owner May 13, 2024 20:18
@ankith26 ankith26 changed the title Invoke makeref directly instead of setup.py Deprecate setup.py docs, suggest and use replacement buildconfig/makeref.py May 15, 2024
@ankith26 ankith26 changed the title Deprecate setup.py docs, suggest and use replacement buildconfig/makeref.py Deprecate setup.py docs, make docs in meson build May 18, 2024
@MyreMylar
Copy link
Member

Should we take the opportunity to rename 'makeref.py' if it is going to be user facing? That is kind of a terrible name for a 'build the docs' script file.

@ankith26
Copy link
Member Author

ankith26 commented May 23, 2024

How about just renaming it to just docs.py? or make_docs.py?

UPDATE: have renamed it to make_docs.py.

Copy link
Member

@MyreMylar MyreMylar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, that works for me 👍

Copy link
Member

@zoldalma999 zoldalma999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, nice to see progress on moving away from setup.py

@zoldalma999 zoldalma999 merged commit 17f57ef into main May 25, 2024
39 checks passed
@zoldalma999 zoldalma999 added this to the 2.5.0 milestone May 25, 2024
@ankith26 ankith26 deleted the ankith26-use-makeref branch May 25, 2024 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants