Remove API link titles for Intersphinx links?
Nobody has claimed this yet.
- Dominant language
- Jupyter Notebook
- Stars
- 106
- Forks
- 223
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 72
Description
Intersphinx cross-references set a link "title" like (in Qiskit v1.3). This title shows up when you hover over the link:
This title is really annoying for our Git diffs because when e.g. a new version of Python or Qiskit is used, every single cross-reference to that library has a diff.
I suspect the title is low-value to our users, so Arnau and I are wondering if we could remove them.
We may also want to remove titles for cross-references to the same API, which look like this:
Contributor guide
No contributing guide indexed for this repository
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
No file or test is named in the issue. Start by locating the Intersphinx configuration or rendering entry point in the documentation repository, then inspect how titles are added for external and same-API cross-references. Done means both kinds of links render without titles and the documentation build remains successful.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100