sphinx-doc / sphinx-doc/sphinx
Override the target of source links
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 8k
- Forks
- 2.6k
- PR merge metrics
- No merged PRs in 30d
Description
For the documentation of large classes, it is helpful to create a dedicated and structured overview page, e.g.
https://matplotlib.org/stable/api/axes_api.html#module-matplotlib.axes
when I now reference the class :class:`.Axes` , the link goes to the class docstring page. I'd rather have the link go to the overview page.
Is there a way to override where such links resolve to? Or alternatively, do you have an idea how to better solve this?
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 :class:.Axes reference and comparing it with the linked overview and class-docstring pages. Investigate how Sphinx resolves this reference, then define what a configurable override should look like and how success would be verified.
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
- 30/100