sphinx-doc/sphinx

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

Open

#9,409 opened on Jul 6, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Python (1,985 forks)batch import
awaiting:reviewgood first issuetype:docs

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 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

Research direction
Add documentation for the 'translatable' node in the 'Doctree node classes added by Sphinx' page and the 'i18n API' page, referencing the source code at sphinx/addnodes.py.
Tech stack
python
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitSphinx basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80