From: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Date: Tue, 22 Oct 2024 13:07:09 +0000 (+0100)
Subject: Doc: Show object descriptions in the table of contents (#125757)
X-Git-Tag: v3.14.0a2~330
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d;p=thirdparty%2FPython%2Fcpython.git

Doc: Show object descriptions in the table of contents (#125757)
---

diff --git a/Doc/conf.py b/Doc/conf.py
index db8fb9a9a68c..7ee3c9158134 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -94,7 +94,8 @@ needs_sphinx = '7.2.6'
 
 # 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 bcb8a421e32d..f4df7ec08393 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 000000000000..0a80f516f283
--- /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;
+}