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

Don't refer to /index in API table of contents for Qiskit #227

Closed
1 of 5 tasks
SooluThomas opened this issue Oct 23, 2023 · 1 comment · Fixed by #500
Closed
1 of 5 tasks

Don't refer to /index in API table of contents for Qiskit #227

SooluThomas opened this issue Oct 23, 2023 · 1 comment · Fixed by #500

Comments

@SooluThomas
Copy link
Member

URL to the relevant documentation

https://docs.quantum-computing.ibm.com/api/qiskit/index

Select all that apply

  • typo
  • code bug
  • out-of-date content
  • broken link
  • other

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.

image

@Eric-Arellano Eric-Arellano added this to the dec release milestone Oct 23, 2023
@Eric-Arellano Eric-Arellano changed the title Getting 404 in API References page Don't refer to /index in API table of contents for Qiskit Nov 9, 2023
@Eric-Arellano
Copy link
Collaborator

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 /index since it should solely be /api/qiskit.

There's no longer a user bug, at least, though. So this can drop in priority.

The problem is here:

{
"title": "qiskit",
"url": "/api/qiskit/index"
},

Note that it's only a problem for Qiskit, not Runtime and Provider.

@Eric-Arellano Eric-Arellano removed their assignment Nov 21, 2023
@Eric-Arellano Eric-Arellano moved this to In Review in Docs Planning Dec 8, 2023
github-merge-queue bot pushed a commit that referenced this issue Dec 8, 2023
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
@github-project-automation github-project-automation bot moved this from In Review to Done in Docs Planning Dec 8, 2023
frankharkins pushed a commit to frankharkins/documentation that referenced this issue Jul 22, 2024
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

6 participants