-
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
Don't refer to /index
in API table of contents for Qiskit
#227
Comments
/index
in API table of contents for Qiskit
The URL https://docs.quantum-computing.ibm.com/api/qiskit/index no longer breaks. Although it's still a little weird to refer to it with the There's no longer a user bug, at least, though. So this can drop in priority. The problem is here: documentation/docs/api/qiskit/_toc.json Lines 5 to 8 in 5768b65
Note that it's only a problem for Qiskit, not Runtime and Provider. |
This PR fixes the issue with the undefined span IDs when generating the documentation and transforms the `/api/qiskit/index` entry in the toc file to `/api/qiskit`. A new test has been added to verify we don't generate span tags with an undefined id. The Qiskit docs have been regenerated to verify the correct behavior of the script for the current version. The changes in the docs files are empty lines matching the great work done by @Eric-Arellano in #484 removing the tags manually. Closes #485 Closes #227
This PR fixes the issue with the undefined span IDs when generating the documentation and transforms the `/api/qiskit/index` entry in the toc file to `/api/qiskit`. A new test has been added to verify we don't generate span tags with an undefined id. The Qiskit docs have been regenerated to verify the correct behavior of the script for the current version. The changes in the docs files are empty lines matching the great work done by @Eric-Arellano in Qiskit#484 removing the tags manually. Closes Qiskit#485 Closes Qiskit#227
URL to the relevant documentation
https://docs.quantum-computing.ibm.com/api/qiskit/index
Select all that apply
Describe the fix.
When on the page https://docs.quantum-computing.ibm.com/api/qiskit and I try to click "qiskit" section under the API References (see screenshot), I am taken to the link https://docs.quantum-computing.ibm.com/api/qiskit/index and getting a 404.
The text was updated successfully, but these errors were encountered: