sphinx-doc / sphinx-doc/sphinx
ENH: Track and display backrefs
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.
Which narrative documentation pages reference this source module?
How do I list those backrefs in built Sphinx output?
Could I cache those backrefs as docstrings in the source module with e.g. redbaron?
Describe the solution you'd like
Track and display backrefs for module/function/class/method roles
- determine where to store the list of backrefs
- update roles
- update templates
...
- cache (some?) sphinx-discovered backrefs in source docstrings
Describe alternatives you've considered
None
Additional context
None
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 tracing how module, function, class, and method roles are handled and how templates produce built Sphinx output. Determine where backrefs can be stored, then define how role handling and templates should expose them. The work is done when backrefs are tracked and displayed for all listed roles; caching them in source docstrings with redbaron remains an optional unresolved item.
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
- 25/100