Remove undefined spans from historical API docs #484
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-merge-queue bot
pushed a commit
that referenced
this pull request
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
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
I'm not sure why the script set these and still does: Qiskit#485. While they aren't rendered to the user, we shouldn't have multiple HTML elements with the same ID. Updated with this: ```bash rg '<span id="undefined" />' -l | xargs sd -s '<span id="undefined" />' '' ``` We should find a proper fix in Qiskit#485, but this is a good workaround for now. We're unlikely to regenerate historical API docs, so this will workaround those ones. For current docs, we can regenerate once we have a fix.
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm not sure why the script set these and still does: #485. While they aren't rendered to the user, we shouldn't have multiple HTML elements with the same ID.
Updated with this:
We should find a proper fix in #485, but this is a good workaround for now. We're unlikely to regenerate historical API docs, so this will workaround those ones. For current docs, we can regenerate once we have a fix.