Remove confusing API index pages in Qiskit 0.19 #1258
Merged
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
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:
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 modulesqiskit.aqua
andqiskit.providers.ibmq
.Having the three duplicate
qiskit
entries 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.