docs: fix changelog page heading levels and sidebar - #1171
Merged
Conversation
henryiii
force-pushed
the
docs/changelog-toc
branch
from
August 29, 2026 19:50
cf16a97 to
941cd03
Compare
Give the changelog page its own title so version headings become sections: the current version now appears in the page ToC at the same level as older versions. Fold the changelog link into the Development sidebar section and use :titlesonly: to keep version headings out of the sidebar. Exclude docs/changelog.rst from docstrfmt, which rewrote the title to the same level as the included CHANGELOG.rst headings. Assisted-by: ClaudeCode:claude-fable-5 Claude-Session: https://claude.ai/code/session_018JS2hRNjfymjCZez1jvGVV
henryiii
force-pushed
the
docs/changelog-toc
branch
from
August 30, 2026 03:54
941cd03 to
dcf2dd7
Compare
henryiii
marked this pull request as ready for review
August 30, 2026 03:58
gaborbernat
reviewed
Aug 30, 2026
| - id: docstrfmt | ||
| args: ["-l", "120"] | ||
| additional_dependencies: ["sphinx>=9.1"] | ||
| # title must outrank the included CHANGELOG.rst headings |
Contributor
There was a problem hiding this comment.
We're relying on this to reformat the changelog fragments. Is this the right approach to give up on that?
Contributor
Author
There was a problem hiding this comment.
This is not where the changelog fragments go. It’s a nearly empty file that includes the one without a title.
layday
approved these changes
Aug 30, 2026
henryiii
added a commit
that referenced
this pull request
Sep 9, 2026
## Description Fix up the display of the changelog; now just a normal entry, the ToC is now nested properly (first entry was raised a level before due to docstrfmt rewriting it). <!-- Describe what changes you made and why --> ## Changelog <!-- All PRs should include a changelog fragment in docs/changelog/ --> None needed. - [ ] Added changelog fragment: `docs/changelog/<pr_number>.<type>.rst` - Types: `feature`, `bugfix`, `doc`, `removal`, `misc` - Example: `123.feature.rst` containing `` Add custom backend support - by :user:`yourname` `` ## Checklist - [ ] Tests pass locally (`tox`) - [ ] Code follows project style (`tox -e fix`) - [ ] Type checks pass (`tox -e type`) - [x] Documentation builds (`tox -e docs`)
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Description
Fix up the display of the changelog; now just a normal entry, the ToC is now nested properly (first entry was raised a level before due to docstrfmt rewriting it).
Changelog
None needed.
docs/changelog/<pr_number>.<type>.rstfeature,bugfix,doc,removal,misc123.feature.rstcontainingAdd custom backend support - by :user:`yourname`Checklist
tox)tox -e fix)tox -e type)tox -e docs)