Fix docstring of sphinx.util.parsing.nested_parse_to_nodes(). #13884
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
Set the "parent" attribute of RSTState instances to the `document` instead of None. The attribute holds the state machines "current node" which is initialized to the `document` in `RSTStateMachine.run()` and required since Docutils 0.22.1 in `RSTState.nested_parse()` to correctly support sections in nested parsing.
"section" elements can only be children of "document" or "section" elements, not "sidebar". Cf. https://docutils.sourceforge.io/docs/ref/doctree.html#section
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.
The utility function
sphinx.util.parsing.nested_parse_to_nodes()allowsnested parsing with support for sections.
This is a "power user" feature with known problems and usage restrictions.
Purpose
Inform the user about the risks and limitations when using
nested_parse_to_nodes().References