Improve Qiskit release notes ToC settings #965
Merged
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
|
Thanks for contributing to Qiskit documentation! 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. Thanks! 🙌 |
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#941 This PR sets the `in_page_toc_max_heading_level` to 4 for legacy versions of qiskit (< 0.45) and to 3 for 0.45+ versions. It also changes the description of all the release notes to match the one we are using in the API generation script: `Changes made in Qiskit {version}` Given that we don't regenerate legacy release notes using the script, we can set the `in_page_toc_max_heading_level` to 3 for all qiskit versions and 2 for the rest of the APIs. The changes to the latest release note were done by removing the file and regenerating the 1.0.1 version. The rest of the files we manually updated.
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.
Closes #941
This PR sets the
in_page_toc_max_heading_levelto 4 for legacy versions of qiskit (< 0.45) and to 3 for 0.45+ versions. It also changes the description of all the release notes to match the one we are using in the API generation script:Changes made in Qiskit {version}Given that we don't regenerate legacy release notes using the script, we can set the
in_page_toc_max_heading_levelto 3 for all qiskit versions and 2 for the rest of the APIs.The changes to the latest release note were done by removing the file and regenerating the 1.0.1 version. The rest of the files we manually updated.