Reorganize transpiler modules in API docs (cherry-pick of #1645) #1646
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.
Closes Qiskit/documentation#1240 and partially addresses Qiskit/documentation#942 for runtime.
Reduces
transpiler
modulesBefore:
passes
basis
andscheduling
Now:
ConvertIdToDelay
andscheduling
This saves the user clicks. Now each page is useful enough to stand on its own.
This is what the index page now looks like:
This change assumes that we will not add new modules to
qiskit.transpiler
for some time, such asqiskit.transpiler.my_module
. If we do eventually add a new module, then we can easily reverttranspiler.rst
to point toqiskit_ibm_runtime.transpiler
again.This change also assumes that we won't lots of new APIs to
qiskit.transpiler.passes.basis
. If we do, we would want to consider going back toqiskit.transpiler.passes.basis
being its own standalone page. We can do that easily if necessary in the future.Improves header hierarchy
Options
Before, we were using bold text to act like headers. Instead, we should be using proper headers for styling, SEO, and accessibility (screen readers).
qiskit_ibm_runtime.transpiler.passes.scheduling
This PR moves the
classes
list to be higher in the file and fixes some of the other headers to higher heading levels.Removes unused docstrings
The
utils
module is not exposed, and Kevin said it should not be since it's internal. So I deleted its docstring to make this more clear.