Fix Docs Generation #115
Closed
Fix Docs Generation #115
Conversation
This file contains 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
Updated version in setup.py an in docs conf.py
In the case of :class`MechTypes`s, the "s" at the end was causing Sphinx to fail to parse the class markup. This fixes that by rewording slightly to remove the need for the trailing "s".
The requires_rfc.py docs extension was not properly setting the parent node when adding child text nodes. This caused a hiccup in newer versions of Sphinx, meaning we could not generate new documentation. This commit should fix that by using methods to clear and set the children, as opposed to directly setting the child list.
DirectXMan12
force-pushed
the
infra/fix-docs-generation
branch
from
2b630af
to
9123a56
Compare
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.
This fixes the warnings on the parsing of references to
MechType, and fixes the bug inrequires_rfc.pypreventing us from generating documentation in newer versions of Sphinx.