docs: document the translatable node class#14350
Open
r266-tech wants to merge 1 commit intosphinx-doc:masterfrom
Open
docs: document the translatable node class#14350r266-tech wants to merge 1 commit intosphinx-doc:masterfrom
r266-tech wants to merge 1 commit intosphinx-doc:masterfrom
Conversation
The translatable node class in sphinx.addnodes allows extensions to supply custom translation strings, but was not documented on the 'Doctree node classes added by Sphinx' page. Fixes sphinx-doc#9409
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
translatablenode class insphinx.addnodesallows extensions to supply custom translation strings, but was not documented on the "Doctree node classes added by Sphinx" page.This PR adds the
translatableautoclass directive todoc/extdev/nodes.rstin the "Special nodes" section, where other special base classes likeglossaryandtoctreeare documented.The class already has good docstrings in the source code, so the
autoclassdirective will automatically render them.Fixes #9409