Skip to content

Comments

docs: add table of contents to sidebar#666

Merged
AlexWaygood merged 1 commit intopython:mainfrom
brianschubert:docs-add-toc
Aug 30, 2025
Merged

docs: add table of contents to sidebar#666
AlexWaygood merged 1 commit intopython:mainfrom
brianschubert:docs-add-toc

Conversation

@brianschubert
Copy link
Contributor

Replace the empty navigation template in the sidebar with Sphinx's local table of contents template:
https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars

Also opportunistically add a tagline description (copied from GitHub).

@brianschubert
Copy link
Contributor Author

Preview:

Before After
Desktop image image
Mobile image image

@AlexWaygood AlexWaygood added the documentation Improvements or additions to documentation label Aug 30, 2025
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Excellent, thank you!

@AlexWaygood AlexWaygood merged commit 944a351 into python:main Aug 30, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants