Skip to content

docs: add table of contents to sidebar #666

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
AlexWaygood merged 1 commit into from
Aug 30, 2025
+17 −0
Merged

docs: add table of contents to sidebar #666

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
17 changes: 17 additions & 0 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,23 @@

html_theme = 'alabaster'

html_theme_options = {
"description": "Backported and experimental type hints for Python",
# Make the sidebar "sticky" so that is stays visible when scrolling.
# Also makes the sidebar appear at the top of the page on mobile.
"fixed_sidebar": True,
}

html_sidebars = {
'**': [
'about.html',
'searchfield.html',
'localtoc.html',
]
}

# Don't include object entries (e.g. functions, classes) in the table of contents.
toc_object_entries = False

class MyTranslator(HTML5Translator):
"""Adds a link target to name without `typing_extensions.` prefix."""
Expand Down
Loading