-
Notifications
You must be signed in to change notification settings - Fork 86
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
API docs script should relativize internal links #493
Comments
javabster
modified the milestones:
24-05-21 qiskit 1.0 release part 2,
runtime primitives release
Feb 16, 2024
Eric-Arellano
added a commit
that referenced
this issue
Feb 22, 2024
This is prework for #493 to relativize links to docs.quantum.ibm.com. This refactors the code that we'll be modifying: * Always applies the link transformation, whereas before it wasn't used on Qiskit. * renames `updateUrl` to `normalizeUrl` * renames `transformLink` to `relativizeLink` * adds tests for `relativizeLink`
github-merge-queue bot
pushed a commit
that referenced
this issue
Feb 23, 2024
Closes #493. This change makes our link checker work better because it can quickly validate the relative links and also validate anchors, whereas external links are much slower. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
This is prework for Qiskit#493 to relativize links to docs.quantum.ibm.com. This refactors the code that we'll be modifying: * Always applies the link transformation, whereas before it wasn't used on Qiskit. * renames `updateUrl` to `normalizeUrl` * renames `transformLink` to `relativizeLink` * adds tests for `relativizeLink`
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this issue
Jul 22, 2024
Closes Qiskit#493. This change makes our link checker work better because it can quickly validate the relative links and also validate anchors, whereas external links are much slower. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
If API docs use https://docs.quantum.ibm.com/start/configure-qiskit-local, then we should change this to
/start/configure-qiskit-local
. That is, we should chop off the prefix.We actually already did this for
qiskit.org
:documentation/scripts/lib/api/Pkg.ts
Lines 386 to 404 in bbccec5
We need to keep that code for historical API docs. But we should expand it to handle
https://docs.quantum.ibm.com
andhttps://docs.quantum-computing.ibm.com
. We should also apply the logic to Qiskit, whereas right now it only is used for Runtime and Provider.The text was updated successfully, but these errors were encountered: