Skip to content

docs: document translatable addnode#14348

Open
terminalchai wants to merge 2 commits intosphinx-doc:masterfrom
terminalchai:docs/document-translatable-node
Open

docs: document translatable addnode#14348
terminalchai wants to merge 2 commits intosphinx-doc:masterfrom
terminalchai:docs/document-translatable-node

Conversation

@terminalchai
Copy link

Summary

  • document sphinx.addnodes.translatable on the doctree node reference page
  • mention translatable Sphinx nodes on the i18n API page and link back to the node reference

Validation

  • uv sync --python 3.12 --group docs
  • uv run --python 3.12 sphinx-build -b dummy ./doc ./build/sphinx/extdev --fail-on-warning doc/extdev/nodes.rst doc/extdev/i18n.rst

Closes #9409

Copy link

@themavik themavik left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: .. autoclass:: translatable may not resolve unless the doc path maps that bare name; consider sphinx.addnodes.translatable if the doc build warns or omits the class page.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

translatable node is not documented on the page 'Doctree node classes added by Sphinx'

2 participants