Skip to content

Commit dcf2dd7

Browse files
committed
docs: fix changelog page heading levels and sidebar
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
1 parent 0a3a060 commit dcf2dd7

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

.pre-commit-config.yaml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ repos:
4444
- id: docstrfmt
4545
args: ["-l", "120"]
4646
additional_dependencies: ["sphinx>=9.1"]
47+
# title must outrank the included CHANGELOG.rst headings
48+
exclude: ^docs/changelog\.rst$
4749
- repo: https://github.com/astral-sh/ruff-pre-commit
4850
rev: aab412d509121cb5f7533134b7e67f9fab59c682 # frozen: v0.16.4
4951
hooks:

docs/changelog.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1+
===========
2+
Changelog
3+
===========
4+
15
.. include:: ../CHANGELOG.rst

0 commit comments

Comments
 (0)