diff options
| author | Adam Turner <9087854+AA-Turner@users.noreply.github.com> | 2024-10-22 13:07:09 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-22 13:07:09 (GMT) |
| commit | 91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d (patch) | |
| tree | 0f7bd48590a21446937d1dd7915d85493105859f | |
| parent | 759a54d28ffe7eac8c23917f5d3dfad8309856be (diff) | |
| download | cpython-91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d.zip cpython-91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d.tar.gz cpython-91ddde4af0c3031c84a967bcf59f6fb4f8a48c0d.tar.bz2 | |
Doc: Show object descriptions in the table of contents (#125757)
| -rw-r--r-- | Doc/conf.py | 3 | ||||
| -rw-r--r-- | Doc/tools/extensions/pyspecific.py | 1 | ||||
| -rw-r--r-- | Doc/tools/static/sidebar-wrap.css | 6 |
3 files changed, 9 insertions, 1 deletions
diff --git a/Doc/conf.py b/Doc/conf.py index db8fb9a..7ee3c91 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 bcb8a42..f4df7ec 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 0000000..0a80f51 --- /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; +} |