Reorganize API index page into sections #12333
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
Eric-Arellano
added
on hold
Pull Request Test Coverage Report for Build 9021265465Details
💛 - Coveralls |
Eric-Arellano
changed the title
Eric-Arellano
force-pushed
the
EA/index-page
branch
from
c426e82 to
4333865
Compare
|
One or more of the the following people are requested to review this:
|
github-merge-queue bot
pushed a commit
to Qiskit/documentation
that referenced
this pull request
May 7, 2024
Closes #1211. See Qiskit/qiskit#12333 for the sibling PR in Qiskit. We'll land the test #1300 once both PRs have landed. This uses the same grouping as #1211 (comment), if people prefer reviewing the list over code. Before: <img width="254" alt="Screenshot 2024-05-01 at 10 27 43 AM" src="https://github.com/Qiskit/documentation/assets/14852634/5b503347-accd-4847-a7e2-aedf3546fcba"> After: <img width="269" alt="Screenshot 2024-05-01 at 10 28 02 AM" src="https://github.com/Qiskit/documentation/assets/14852634/c1a358f6-26f5-4e6e-80e9-2ee440eec94f"> <img width="272" alt="Screenshot 2024-05-01 at 10 28 15 AM" src="https://github.com/Qiskit/documentation/assets/14852634/c3c80ca7-96e5-4942-ac39-6795b9504277"> This also improves historical APIs <img width="271" alt="Screenshot 2024-05-01 at 10 29 08 AM" src="https://github.com/Qiskit/documentation/assets/14852634/362cc70f-4c7e-49c4-9447-78af2a648452">
SooluThomas
previously approved these changes
May 9, 2024
mtreinish
reviewed
May 9, 2024
| qiskit.synthesis.unitary.aqc | ||
| transpiler | ||
| transpiler_passes | ||
| transpiler_synthesis_plugins |
There was a problem hiding this comment.
Is this supposed to be in alphabetical order? If so wouldn't it be at the end of the list?
There was a problem hiding this comment.
Should be alphabetical based on the module name, not the RST file name. We want to mirror the left TOC:
There was a problem hiding this comment.
Ah ok that makes sense. Do you think it's worth updating the comment you added at the top of the file to make that distinction, because when I read that I assumed it meant the filename needed to be in alphabetical order. (although in hindsight this makes a lot more sense given how toctree works)
mtreinish
approved these changes
May 9, 2024
mergify bot
pushed a commit
that referenced
this pull request
May 9, 2024
* Reorganize API index page into sections * Sort alphabetically within each section * Clarify ordering expectation (cherry picked from commit 8c8c78a)
github-merge-queue bot
pushed a commit
to Qiskit/documentation
that referenced
this pull request
May 12, 2024
The Qiskit devs were worried about the index page from Qiskit/qiskit#12333 falling out of sync with our custom grouping for `_toc.json`. This PR adds a test to ensure that the two files are in sync. In particular, it checks that the grouping and sequence of modules is identical. It does not check that the label for the groups are the same, though. For now, we only check the dev docs because the latest docs (1.0) fail. #1341 will also start checking the latest docs once 1.1 is released.
ElePT
pushed a commit
to ElePT/qiskit
that referenced
this pull request
May 31, 2024
* Reorganize API index page into sections * Sort alphabetically within each section * Clarify ordering expectation
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#1211. See Qiskit/qiskit#12333 for the sibling PR in Qiskit. We'll land the test Qiskit#1300 once both PRs have landed. This uses the same grouping as Qiskit#1211 (comment), if people prefer reviewing the list over code. Before: <img width="254" alt="Screenshot 2024-05-01 at 10 27 43 AM" src="https://github.com/Qiskit/documentation/assets/14852634/5b503347-accd-4847-a7e2-aedf3546fcba"> After: <img width="269" alt="Screenshot 2024-05-01 at 10 28 02 AM" src="https://github.com/Qiskit/documentation/assets/14852634/c1a358f6-26f5-4e6e-80e9-2ee440eec94f"> <img width="272" alt="Screenshot 2024-05-01 at 10 28 15 AM" src="https://github.com/Qiskit/documentation/assets/14852634/c3c80ca7-96e5-4942-ac39-6795b9504277"> This also improves historical APIs <img width="271" alt="Screenshot 2024-05-01 at 10 29 08 AM" src="https://github.com/Qiskit/documentation/assets/14852634/362cc70f-4c7e-49c4-9447-78af2a648452">
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
The Qiskit devs were worried about the index page from Qiskit/qiskit#12333 falling out of sync with our custom grouping for `_toc.json`. This PR adds a test to ensure that the two files are in sync. In particular, it checks that the grouping and sequence of modules is identical. It does not check that the label for the groups are the same, though. For now, we only check the dev docs because the latest docs (1.0) fail. Qiskit#1341 will also start checking the latest docs once 1.1 is released.
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.
In Qiskit/documentation#1255 (motivating issue: Qiskit/documentation#1211), we reorganize the Qiskit table of contents into logical groups. This PR changes the index page to mirror the groupings.
Screenshots
index page
docs ToC
Keeping in sync with qiskit/documentation
While we duplicate the groupings between this index page and qiskit/documentation's Sphinx -> MDX pipeline, we will add a test in qiskit/documentation after this PR lands to ensure that the two files are in sync: Qiskit/documentation#1300. Qiskit/qiskit is seen as the source of truth; qiskit/documentation will update to reflect qiskit/qiskit when changes are made.
(Given the docs architecture, it would be non-trivial to have the docs generation generate its groupings based on the index page. It's simpler to validate through a test that runs in CI.)