-
Notifications
You must be signed in to change notification settings - Fork 167
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Link to every module in API index page (#1649)
Before, `qiskit_ibm_runtime.transpiler.passes.scheduling` was autogenerated by `autosummary` rather than being manually created like we normally do in `apidocs/`. This had two issues: 1. The module does not show up in the API index page https://docs.quantum.ibm.com/api/qiskit-ibm-runtime, even though it shows up as top-level in the doc app's left table of contents 2. The header hierarchy is messed up due to an autosummary quirk that I could not figure out Qiskit/documentation#1272 Using a dedicated page fixes both of these problems. I named the file `qiskit_ibm_runtime.transpiler.passes.scheduling.rst` to preserve the previous URL we had for the module. (Technically, Sphinx now puts the HTML file in the `apidocs/` folder rather than `stubs/`, but the docs app doesn't care.) This PR also removes the override of the `module.rst` template. We shouldn't end up using it anymore. Regardless, our version is out-of-date compared with the default and we didn't have any substantial changes.
- Loading branch information
1 parent
60b894c
commit b612ba6
Showing
6 changed files
with
12 additions
and
48 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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,13 +1,14 @@ | ||
.. vale off | ||
***************************************** | ||
******************************** | ||
qiskit-ibm-runtime API reference | ||
***************************************** | ||
******************************** | ||
|
||
.. toctree:: | ||
:maxdepth: 1 | ||
|
||
runtime_service | ||
options | ||
transpiler | ||
qiskit_ibm_runtime.transpiler.passes.scheduling | ||
fake_provider |
4 changes: 4 additions & 0 deletions
4
docs/apidocs/qiskit_ibm_runtime.transpiler.passes.scheduling.rst
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 |
---|---|---|
@@ -0,0 +1,4 @@ | ||
.. automodule:: qiskit_ibm_runtime.transpiler.passes.scheduling | ||
:no-members: | ||
:no-inherited-members: | ||
:no-special-members: |
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
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
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