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

This commit is contained in:
Adam Turner 2024-10-22 14:07:09 +01:00 committed by GitHub
parent 759a54d28f
commit 91ddde4af0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 9 additions and 1 deletions

View File

@ -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.

View File

@ -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}

View File

@ -0,0 +1,6 @@
div.sphinxsidebarwrapper {
overflow-x: scroll;
}
div.sphinxsidebarwrapper li code {
overflow-wrap: normal;
}