sphinx-doc / sphinx-doc/sphinx
glossary terms displayed like abbreviation
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
There's a requirement text that I would like to use in several places in the document.
Using glossary tems is a bit clumsy as they're links and thus the reader has to navigate in the document while he's reading the text.
An abbreviation would be fine as it would give the requirement text in a tooltip while the paragraph would only display the requirement number for better readability.
I tried the following but it seems that substitutions don't work within an abbreviation:
.. |Requirement X| replace:: some requirement text
With regard to :abbr:`Requirement X (|Requirement X|)`, it is proposed to do something.
Is there an enhancement in glossary terms or abbreviations that could be considered ?
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 by reproducing the substitution inside the :abbr: example while building the Sphinx documentation. Then inspect how glossary terms, abbreviations, and substitutions are handled. Done means a documented enhancement or supported behavior that lets reusable requirement text appear in an abbreviation tooltip without forcing reader navigation.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100