Skip to content

Commit

Permalink
Make _resolve_toctree() keyword-only
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Aug 17, 2023
1 parent 76658c4 commit aecebce
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 11 deletions.
20 changes: 14 additions & 6 deletions sphinx/environment/__init__.py
Expand Up @@ -12,7 +12,7 @@
from typing import TYPE_CHECKING, Any, Callable

from sphinx import addnodes
from sphinx.environment.adapters.toctree import _resolve_toctree
from sphinx.environment.adapters import toctree as toctree_adapters
from sphinx.errors import BuildEnvironmentError, DocumentError, ExtensionError, SphinxError
from sphinx.locale import __
from sphinx.transforms import SphinxTransformer
Expand Down Expand Up @@ -636,9 +636,11 @@ def get_and_resolve_doctree(

# now, resolve all toctree nodes
for toctreenode in doctree.findall(addnodes.toctree):
result = _resolve_toctree(self, docname, builder, toctreenode,
prune=prune_toctrees,
includehidden=includehidden)
result = toctree_adapters._resolve_toctree(
self, docname, builder, toctreenode,
prune=prune_toctrees,
includehidden=includehidden,
)
if result is None:
toctreenode.parent.replace(toctreenode, [])
else:
Expand All @@ -660,8 +662,14 @@ def resolve_toctree(self, docname: str, builder: Builder, toctree: addnodes.toct
If *collapse* is True, all branches not containing docname will
be collapsed.
"""
return _resolve_toctree(self, docname, builder, toctree, prune,
maxdepth, titles_only, collapse, includehidden)
return toctree_adapters._resolve_toctree(
self, docname, builder, toctree,
prune=prune,
maxdepth=maxdepth,
titles_only=titles_only,
collapse=collapse,
includehidden=includehidden,
)

def resolve_references(self, doctree: nodes.document, fromdocname: str,
builder: Builder) -> None:
Expand Down
14 changes: 9 additions & 5 deletions sphinx/environment/adapters/toctree.py
Expand Up @@ -65,10 +65,10 @@ def global_toctree_for_doc(
env: BuildEnvironment,
docname: str,
builder: Builder,
maxdepth: int = 0,
titles_only: bool = False,
collapse: bool = False,
includehidden: bool = True,
maxdepth: int = 0,
titles_only: bool = False,
) -> Element | None:
"""Get the global ToC tree at a given document.
Expand Down Expand Up @@ -98,7 +98,7 @@ def global_toctree_for_doc(


def _resolve_toctree(
env: BuildEnvironment, docname: str, builder: Builder, toctree: addnodes.toctree,
env: BuildEnvironment, docname: str, builder: Builder, toctree: addnodes.toctree, *,
prune: bool = True, maxdepth: int = 0, titles_only: bool = False,
collapse: bool = False, includehidden: bool = False,
) -> Element | None:
Expand Down Expand Up @@ -500,8 +500,12 @@ def resolve(self, docname: str, builder: Builder, toctree: addnodes.toctree,
prune: bool = True, maxdepth: int = 0, titles_only: bool = False,
collapse: bool = False, includehidden: bool = False) -> Element | None:
return _resolve_toctree(
self.env, docname, builder, toctree, prune,
maxdepth, titles_only, collapse, includehidden,
self.env, docname, builder, toctree,
prune=prune,
maxdepth=maxdepth,
titles_only=titles_only,
collapse=collapse,
includehidden=includehidden,
)

def get_toc_for(self, docname: str, builder: Builder) -> Node:
Expand Down

0 comments on commit aecebce

Please sign in to comment.