Infra: Fix hiding of References if it contains invisible SystemMessage #3083
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
hugovk
approved these changes
Apr 2, 2023
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.
As originally discovered reviewing PEP 710 (PEP-710) in PR #3076 , the References section does not get hidden as intended if its doctree contains
nodes of typesystem_message, which are invisible docutils messages hidden in the rendered output (and thus not adding any visible content to the section). This can happen if the References section contains any hyperlink target labels that have the same name as the implicit targets generated for each section heading (i.e. the name of the section). This isn't a real issue, particularly since both we and Sphinx discourage using these implict section heading links for multiple reasons anyway, but we should still properly hide the References section in cases like these.Therefore, we just add
nodes.system_messageto the list of "invisible" node types that prompt hiding this section.📚 Documentation preview 📚: https://pep-previews--3083.org.readthedocs.build/