sphinx-doc / sphinx-doc/sphinx
`translatable` node is not documented on the page 'Doctree node classes added by Sphinx'
Open
Nobody has claimed this yet.
awaiting:review
type:docs
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
This node allows supplying custom translation strings.
Link to source: https://github.com/sphinx-doc/sphinx/blob/996c5855bcda6cc49986bcecd18290c9fcd5e06c/sphinx/addnodes.py#L47
It is not present on the Doctree node classes added by Sphinx nor i18n API.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the translatable node definition in sphinx/addnodes.py around line 47, then review the “Doctree node classes added by Sphinx” and i18n API pages linked in the issue. Document what the node does and how it supplies custom translation strings in the appropriate documentation page or pages.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100