Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove API link titles for Intersphinx links? #2526

Open
Eric-Arellano opened this issue Dec 23, 2024 · 1 comment
Open

Remove API link titles for Intersphinx links? #2526

Eric-Arellano opened this issue Dec 23, 2024 · 1 comment

Comments

@Eric-Arellano
Copy link
Collaborator

Intersphinx cross-references set a link "title" like (in Qiskit v1.3). This title shows up when you hover over the link:

Image

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:

Image

@Eric-Arellano
Copy link
Collaborator Author

We're going to get rid of external cross-references, but keep the first-party ones. We agreed they are low value. Frank also pointed out they can be misleading; for example, at the time of generation, the latest docs might be Qiskit 1.3, but our URL is not versioned so that could change to 1.4 in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant