Skip to content

Commit 944a351

Browse files
docs: add table of contents to sidebar (python#666)
1 parent 7f06750 commit 944a351

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

doc/conf.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,23 @@
3838

3939
html_theme = 'alabaster'
4040

41+
html_theme_options = {
42+
"description": "Backported and experimental type hints for Python",
43+
# Make the sidebar "sticky" so that is stays visible when scrolling.
44+
# Also makes the sidebar appear at the top of the page on mobile.
45+
"fixed_sidebar": True,
46+
}
47+
48+
html_sidebars = {
49+
'**': [
50+
'about.html',
51+
'searchfield.html',
52+
'localtoc.html',
53+
]
54+
}
55+
56+
# Don't include object entries (e.g. functions, classes) in the table of contents.
57+
toc_object_entries = False
4158

4259
class MyTranslator(HTML5Translator):
4360
"""Adds a link target to name without `typing_extensions.` prefix."""

0 commit comments

Comments
 (0)