sphinx-doc / sphinx-doc/sphinx
Glossary term index
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
Is your feature request related to a problem? Please describe.
I have noticed that the glossary terms themselves do not have a dedicated index. IMO this would be a prefect usage of the index to get a global alphabetically ordered index. The main use case is when the main glossary page is more structured, e.g. grouped by concepts.
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 reviewing Sphinx's existing glossary and index functionality to identify the relevant entry points; the issue names no files or tests. Define how a global alphabetically ordered glossary-term index should work when glossary content is grouped by concepts, then verify that the resulting index meets that use case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100