handle toctree caption changing from nodes.caption to nodes.title #458
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
As of Sphinx v3.5.4, changes have been made to the application where a `:caption:` hint on a toctree node will create a `nodes.title` instance instead of an `nodes.caption` instance. This modification was introduced to support styling changes introduced in docutils-0.17 [1]. This commit adjusts the `visit_title` to detect if the title entry is being built from a toctree node -- if so, forward the node processing back to the existing caption implementation. [1]: sphinx-doc/sphinx#9053 Signed-off-by: James Knight <[email protected]>
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 of Sphinx v3.5.4, changes have been made to the application where a
:caption:hint on a toctree node will create anodes.titleinstance instead of annodes.captioninstance. This modification was introduced to support styling changes introduced in docutils-0.17 [1].This commit adjusts the
visit_titleto detect if the title entry is being built from a toctree node -- if so, forward the node processing back to the existing caption implementation.[1]: sphinx-doc/sphinx#9053