sphinx-doc / sphinx-doc/sphinx
Document why `:label:` is recommended for `math` directives
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
We had some confusion recently about the recommendation of :label: rather than :name: for the math directives:
In the Sphinx math directive section it recommends using label in order to get numbered equations.
However, the docutils math directive page does not list :label: and does list :name: (similar to how other directives get unique IDs).
Can Sphinx document the reason that it does not recommend using :name: and instead recommends :label: to avoid confusion to users that are referencing both sets of documentation?
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
Read Sphinx's math directive section and the linked docutils math directive page, comparing their treatment of 🏷️ and :name:. Document why Sphinx recommends 🏷️ and clarify how users referencing both sets of documentation should understand the difference.
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
- 48/100