Reorganize API index page into sections (backport #12333) #12381
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
![mergify[bot]](https://avatars.githubusercontent.com/in/10562?s=60&v=4){kind=small}
* Reorganize API index page into sections * Sort alphabetically within each section * Clarify ordering expectation (cherry picked from commit 8c8c78a)
|
Thank you for opening a new pull request. Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient. While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone. One or more of the the following people are requested to review this:
|
github-actions
bot
added
documentation
Pull Request Test Coverage Report for Build 9022667421Details
💛 - Coveralls |
mtreinish
approved these changes
May 9, 2024
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.)
This is an automatic backport of pull request #12333 done by Mergify.