Remove confusing API index pages in Qiskit 0.19 #1258
Merged
Conversation
This file contains hidden or 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
frankharkins
approved these changes
Apr 30, 2024
Member
frankharkins
left a comment
frankharkins
left a comment
There was a problem hiding this comment.
Thanks! I agree with this solution. Weird that these only appear in 0.19
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
## Problem This is how Qiskit 0.19 looks: <img width="260" alt="Screenshot 2024-04-29 at 5 00 14 PM" src="https://github.com/Qiskit/documentation/assets/14852634/151d56df-09d2-47c6-885b-a8ce6f6e931a"> The three `qiskit` entries are: https://docs.quantum.ibm.com/api/qiskit/0.19 https://docs.quantum.ibm.com/api/qiskit/0.19/ibmq-provider https://docs.quantum.ibm.com/api/qiskit/0.19/aqua 0.19 is the only version like that, e.g. Qiskit 0.24 doesn't have duplicates: <img width="266" alt="Screenshot 2024-04-29 at 5 00 36 PM" src="https://github.com/Qiskit/documentation/assets/14852634/93f4c64e-7427-41d3-9deb-ae8f5ebcd758"> In 0.19 docs, the first two `qiskit` entries are index pages for Qiskit Aqua and Qiskit IBMQ Provider. Those are index pages that simply list all modules, rather than module overview pages that describe the modules `qiskit.aqua` and `qiskit.providers.ibmq`. Having the three duplicate `qiskit` entries is going to be a problem with Qiskit#1211 when we group modules. ## Solution I simply deleted the two index files from the HTML and regenerated the docs. If we like this PR, I will upload that HTML change to Box. I went with deletion because it's the simplest fix. We don't have these index pages in every version after 0.19, and it works fine. Qiskit#1211 will also help with module discovery through better grouping. We could instead rewrite the HTML for the two problematic files, but I figured it's fine to do the simpler approach that's consistent with later versions.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Problem
This is how Qiskit 0.19 looks:
The three
qiskitentries are:https://docs.quantum.ibm.com/api/qiskit/0.19
https://docs.quantum.ibm.com/api/qiskit/0.19/ibmq-provider
https://docs.quantum.ibm.com/api/qiskit/0.19/aqua
0.19 is the only version like that, e.g. Qiskit 0.24 doesn't have duplicates:
In 0.19 docs, the first two
qiskitentries are index pages for Qiskit Aqua and Qiskit IBMQ Provider. Those are index pages that simply list all modules, rather than module overview pages that describe the modulesqiskit.aquaandqiskit.providers.ibmq.Having the three duplicate
qiskitentries is going to be a problem with #1211 when we group modules.Solution
I simply deleted the two index files from the HTML and regenerated the docs. If we like this PR, I will upload that HTML change to Box.
I went with deletion because it's the simplest fix. We don't have these index pages in every version after 0.19, and it works fine. #1211 will also help with module discovery through better grouping.
We could instead rewrite the HTML for the two problematic files, but I figured it's fine to do the simpler approach that's consistent with later versions.