Docs generation is now python -m buildconfig docs and python -m buildconfig docs full_generation
#2942
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…cs instead of calling make_docs.py directly
damusss
reviewed
Jun 26, 2024
There was a problem hiding this comment.
When running it from setup.py it says Please use the following replacement: D:\Programs\Python312\python.exe buildconfig docs full_generation but running that command raises ImportError: attempted relative import with no known parent package as the suggestion is missing '-m'. Other than that, I like this helper
Oops, it's fixed now |
damusss
approved these changes
Jun 27, 2024
ankith26
reviewed
Jun 28, 2024
Co-authored-by: Ankith <itsankith26@gmail.com>
ankith26
approved these changes
Jun 30, 2024
gresm
pushed a commit
to gresm/pygame-ce
that referenced
this pull request
Jul 16, 2024
…ildconfig docs full_generation` (pygame-community#2942) * Can now use python -m buildconfig docs full_generation to generate docs instead of calling make_docs.py directly * Fixed buildconfig command to be a module run * Updated docs readme to point to new command * Stricter command interface (thanks Ankith) Co-authored-by: Ankith <itsankith26@gmail.com> --------- Co-authored-by: Ankith <itsankith26@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I didn't want to have to invoke a specific python file every time I generate docs, so here's a useful helper