sphinx.environment.adapters.toctree.TocTree

Method	`__init__`	Undocumented
Method	`_toctree_prune`	Utility: Cut a TOC at a specified depth.
Method	`get_toc_for`	Return a TOC nodetree -- for use on the same page only!
Method	`get_toctree_ancestors`	Undocumented
Method	`get_toctree_for`	Return the global TOC nodetree.
Method	`note`	Note a TOC tree directive in a document and gather information about file relations from it.
Method	`resolve`	Resolve a toctree node into individual bullet lists with titles as items, returning None (if no containing titles are found) or a new node.
Instance Variable	`env`	Undocumented

def __init__(self, env):

Undocumented

Parameters
env:`BuildEnvironment`	Undocumented

def _toctree_prune(self, node, depth, maxdepth, collapse=False):

Utility: Cut a TOC at a specified depth.

Parameters
node:`Element`	Undocumented
depth:`int`	Undocumented
maxdepth:`int`	Undocumented
collapse:`bool`	Undocumented

def get_toc_for(self, docname, builder):

Return a TOC nodetree -- for use on the same page only!

Parameters
docname:`str`	Undocumented
builder:`Builder`	Undocumented
Returns
`Node`	Undocumented

def get_toctree_ancestors(self, docname):

Undocumented

Parameters
docname:`str`	Undocumented
Returns
`List[str]`	Undocumented

def get_toctree_for(self, docname, builder, collapse, **kwargs):

Return the global TOC nodetree.

Parameters
docname:`str`	Undocumented
builder:`Builder`	Undocumented
collapse:`bool`	Undocumented
**kwargs:`Any`	Undocumented
Returns
`Optional[Element]`	Undocumented

def note(self, docname, toctreenode):

Note a TOC tree directive in a document and gather information about file relations from it.

Parameters
docname:`str`	Undocumented
toctreenode:`addnodes.toctree`	Undocumented

def resolve(self, docname, builder, toctree, prune=True, maxdepth=0, titles_only=False, collapse=False, includehidden=False):

Resolve a toctree node into individual bullet lists with titles as items, returning None (if no containing titles are found) or a new node.

If prune is True, the tree is pruned to maxdepth, or if that is 0, to the value of the maxdepth option on the toctree node. If titles_only is True, only toplevel document titles will be in the resulting tree. If collapse is True, all branches not containing docname will be collapsed.

Parameters
docname:`str`	Undocumented
builder:`Builder`	Undocumented
toctree:`addnodes.toctree`	Undocumented
prune:`bool`	Undocumented
maxdepth:`int`	Undocumented
titles_only:`bool`	Undocumented
collapse:`bool`	Undocumented
includehidden:`bool`	Undocumented
Returns
`Optional[Element]`	Undocumented

env =

Undocumented