Skip to content

Conversation

@beckykd
Copy link
Collaborator

@beckykd beckykd commented Jan 9, 2026

Related to #4336

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@qiskit-bot
Copy link
Contributor

One or more of the following people are relevant to this code:

Copy link
Member

@frankharkins frankharkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

For the links in the API docs, we'll need to add the redirects to scripts/config/external-redirects.ts, otherwise these changes will be discarded when we next regenerate the docs from source.

The format is:

"old":
  "new",

E.g.

"https://aip.scitation.org/doi/10.1063/1.5141835":
"https://pubs.aip.org/aip/jcp/article/152/12/124107/953761/Quantum-orbital-optimized-unitary-coupled-cluster",

beckykd and others added 2 commits January 12, 2026 09:04
@beckykd
Copy link
Collaborator Author

beckykd commented Jan 12, 2026

we'll need to add the redirects

Even though the changes will be made in the API docs themselves?

@frankharkins
Copy link
Member

frankharkins commented Jan 12, 2026

Even though the changes will be made in the API docs themselves?

Yep: We store the original API docs HTML in Box and sometimes re-run the HTML -> markdown pipeline to fix bugs. When this happens, your fixes will be overwritten by the pipeline with the original links. The external-redirects.ts tells the pipeline to do the same link substitution that you've done in this PR.

@beckykd beckykd mentioned this pull request Jan 12, 2026
@beckykd
Copy link
Collaborator Author

beckykd commented Jan 15, 2026

@frankharkins what should we do about links that are broken in historical API documents but don't exist in more recent documents? For example, qaiskit-ibm-runtime/0.40/qiskit-runtime-service links to https://auth.quantum.ibm.com/api. That API no longer exists and the link was just deleted from the later versions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants