Link to every module in API index page (cherry-pick of #1649) #1650
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
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.
Pull Request Test Coverage Report for Build 8924186814Details
💛 - Coveralls |
kt474
approved these changes
May 2, 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.
Before,
qiskit_ibm_runtime.transpiler.passes.schedulingwas autogenerated byautosummaryrather than being manually created like we normally do inapidocs/. This had two issues:Using a dedicated page fixes both of these problems.
I named the file
qiskit_ibm_runtime.transpiler.passes.scheduling.rstto preserve the previous URL we had for the module. (Technically, Sphinx now puts the HTML file in theapidocs/folder rather thanstubs/, but the docs app doesn't care.)This PR also removes the override of the
module.rsttemplate. 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.