-
Notifications
You must be signed in to change notification settings - Fork 2.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize API index page into sections #12333
Merged
Merged
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
4333865
Reorganize API index page into sections
Eric-Arellano 19dd239
Sort alphabetically within each section
Eric-Arellano d606933
Clarify ordering expectation
Eric-Arellano 2413fa6
Merge branch 'main' of github.com:Qiskit/qiskit-terra into EA/index-page
Eric-Arellano File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,42 +1,89 @@ | ||
| .. module:: qiskit | ||
| .. | ||
| Within each section, the modules should be arranged alphabetically to | ||
| align with qiskit/documentation. | ||
|
|
||
| ============= | ||
| API Reference | ||
| ============= | ||
|
|
||
| Circuit construction: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| circuit | ||
| circuit_library | ||
| circuit_classical | ||
| circuit_singleton | ||
| compiler | ||
| visualization | ||
| classicalfunction | ||
| circuit_library | ||
| circuit_singleton | ||
|
|
||
| Quantum information: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| quantum_info | ||
|
|
||
| Transpilation: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| converters | ||
| assembler | ||
| dagcircuit | ||
| passmanager | ||
| synthesis | ||
| qiskit.synthesis.unitary.aqc | ||
| transpiler | ||
| transpiler_passes | ||
| transpiler_synthesis_plugins | ||
| transpiler_preset | ||
| transpiler_plugins | ||
|
|
||
| Primitives and providers: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| primitives | ||
| providers | ||
| providers_basic_provider | ||
| providers_fake_provider | ||
| providers_models | ||
| pulse | ||
| scheduler | ||
| synthesis | ||
| qiskit.synthesis.unitary.aqc | ||
| primitives | ||
|
|
||
| Results and visualizations: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| result | ||
| visualization | ||
|
|
||
| Serialization: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| qasm2 | ||
| qasm3 | ||
| qobj | ||
| qpy | ||
| quantum_info | ||
| result | ||
| transpiler | ||
| transpiler_passes | ||
| transpiler_preset | ||
| transpiler_plugins | ||
| transpiler_synthesis_plugins | ||
| utils | ||
|
|
||
| Pulse-level programming: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| pulse | ||
| scheduler | ||
|
|
||
| Other: | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| assembler | ||
| compiler | ||
| exceptions | ||
| qobj | ||
| utils | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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)