Skip to content

docs: fix changelog page heading levels and sidebar #1171

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henryiii merged 1 commit into from
Aug 30, 2026
Merged

docs: fix changelog page heading levels and sidebar #1171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,8 @@ repos:
- id: docstrfmt
args: ["-l", "120"]
additional_dependencies: ["sphinx>=9.1"]
# title must outrank the included CHANGELOG.rst headings

@gaborbernat gaborbernat Aug 30, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We're relying on this to reformat the changelog fragments. Is this the right approach to give up on that?

@henryiii henryiii Aug 30, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not where the changelog fragments go. It’s a nearly empty file that includes the one without a title.

exclude: ^docs/changelog\.rst$
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: aab412d509121cb5f7533134b7e67f9fab59c682 # frozen: v0.16.4
hooks:
Expand Down
4 changes: 4 additions & 0 deletions docs/changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
===========
Changelog
===========

.. include:: ../CHANGELOG.rst
Loading