Skip to content

Commit

Permalink
[3.13] Doc: Show object descriptions in the table of contents (GH-125757
Browse files Browse the repository at this point in the history
) (#125840)

(cherry picked from commit 91ddde4)

Co-authored-by: Adam Turner <[email protected]>
  • Loading branch information
miss-islington and AA-Turner authored Oct 22, 2024
1 parent 1fe63b1 commit 22ae72b
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
3 changes: 2 additions & 1 deletion Doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
1 change: 1 addition & 0 deletions Doc/tools/extensions/pyspecific.py
Original file line number Diff line number Diff line change
Expand Up @@ -411,5 +411,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}
6 changes: 6 additions & 0 deletions Doc/tools/static/sidebar-wrap.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
div.sphinxsidebarwrapper {
overflow-x: scroll;
}
div.sphinxsidebarwrapper li code {
overflow-wrap: normal;
}

0 comments on commit 22ae72b

Please sign in to comment.