https://github.com/python/cpython/commit/91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d
commit: 91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d
branch: main
author: Adam Turner <[email protected]>
committer: AA-Turner <[email protected]>
date: 2024-10-22T14:07:09+01:00
summary:
Doc: Show object descriptions in the table of contents (#125757)
files:
A Doc/tools/static/sidebar-wrap.css
M Doc/conf.py
M Doc/tools/extensions/pyspecific.py
diff --git a/Doc/conf.py b/Doc/conf.py
index db8fb9a9a68c6b..7ee3c91581345d 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -94,7 +94,8 @@
# Create table of contents entries for domain objects (e.g. functions, classes,
# attributes, etc.). Default is True.
-toc_object_entries = False
+toc_object_entries = True
+toc_object_entries_show_parents = 'hide'
# Ignore any .rst files in the includes/ directory;
# they're embedded in pages but not rendered individually.
diff --git a/Doc/tools/extensions/pyspecific.py
b/Doc/tools/extensions/pyspecific.py
index bcb8a421e32d09..f4df7ec0839339 100644
--- a/Doc/tools/extensions/pyspecific.py
+++ b/Doc/tools/extensions/pyspecific.py
@@ -434,5 +434,6 @@ def setup(app):
app.add_directive_to_domain('py', 'awaitablemethod', PyAwaitableMethod)
app.add_directive_to_domain('py', 'abstractmethod', PyAbstractMethod)
app.add_directive('miscnews', MiscNews)
+ app.add_css_file('sidebar-wrap.css')
app.connect('env-check-consistency', patch_pairindextypes)
return {'version': '1.0', 'parallel_read_safe': True}
diff --git a/Doc/tools/static/sidebar-wrap.css
b/Doc/tools/static/sidebar-wrap.css
new file mode 100644
index 00000000000000..0a80f516f28349
--- /dev/null
+++ b/Doc/tools/static/sidebar-wrap.css
@@ -0,0 +1,6 @@
+div.sphinxsidebarwrapper {
+ overflow-x: scroll;
+}
+div.sphinxsidebarwrapper li code {
+ overflow-wrap: normal;
+}
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
