IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Slightly simplify toctree code (#12724)

Browse Source
This commit is contained in:
Tim Hoffmann 2024-08-09 22:22:12 +02:00 committed by GitHub
parent 4f270a5da9
commit d40840ebf1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
sphinx/directives/other.py
View File

@ -78,17 +78,19 @@ class TocTree(SphinxDirective):
subnode['numbered'] = self.options.get('numbered', 0) subnode['numbered'] = self.options.get('numbered', 0)
subnode['titlesonly'] = 'titlesonly' in self.options subnode['titlesonly'] = 'titlesonly' in self.options
self.set_source_info(subnode) self.set_source_info(subnode)
self.parse_content(subnode)
wrappernode = nodes.compound( wrappernode = nodes.compound(
classes=['toctree-wrapper', *self.options.get('class', ())], classes=['toctree-wrapper', *self.options.get('class', ())],
) )
wrappernode.append(subnode) wrappernode.append(subnode)
self.add_name(wrappernode) self.add_name(wrappernode)
return [wrappernode]
ret = self.parse_content(subnode) def parse_content(self, toctree: addnodes.toctree) -> None:
ret.append(wrappernode) """
return ret Populate ``toctree['entries']`` and ``toctree['includefiles']`` from content.
"""
def parse_content(self, toctree: addnodes.toctree) -> list[Node]:
generated_docnames = frozenset(StandardDomain._virtual_doc_names) generated_docnames = frozenset(StandardDomain._virtual_doc_names)
suffixes = self.config.source_suffix suffixes = self.config.source_suffix
current_docname = self.env.docname current_docname = self.env.docname
@ -99,7 +101,6 @@ class TocTree(SphinxDirective):
all_docnames.remove(current_docname) # remove current document all_docnames.remove(current_docname) # remove current document
frozen_all_docnames = frozenset(all_docnames) frozen_all_docnames = frozenset(all_docnames)
ret: list[Node] = []
excluded = Matcher(self.config.exclude_patterns) excluded = Matcher(self.config.exclude_patterns)
for entry in self.content: for entry in self.content:
if not entry: if not entry:
@ -170,8 +171,6 @@ class TocTree(SphinxDirective):
toctree['entries'] = list(reversed(toctree['entries'])) toctree['entries'] = list(reversed(toctree['entries']))
toctree['includefiles'] = list(reversed(toctree['includefiles'])) toctree['includefiles'] = list(reversed(toctree['includefiles']))
return ret
class Author(SphinxDirective): class Author(SphinxDirective):
""" """