sphinx.environment.collectors.toctree.TocTreeCollector

class documentation

class TocTreeCollector(EnvironmentCollector):

Undocumented

Method	`assign_figure_numbers`	Assign a figure number to each figure under a numbered toctree.
Method	`assign_section_numbers`	Assign a section number to each heading under a numbered toctree.
Method	`clear_doc`	Remove specified data of a document.
Method	`get_updated_docs`	Return a list of docnames to re-read.
Method	`merge_other`	Merge in specified data regarding docnames from a different `BuildEnvironment` object which coming from a subprocess in parallel builds.
Method	`process_doc`	Build a TOC from the doctree and store it in the inventory.

Method	`get_outdated_docs`	Return a list of docnames to re-read.
Method	`disable`	Undocumented
Method	`enable`	Undocumented
Instance Variable	`listener_ids`	Undocumented

def assign_figure_numbers(self, env):

Assign a figure number to each figure under a numbered toctree.

def assign_section_numbers(self, env):

Assign a section number to each heading under a numbered toctree.

def clear_doc(self, app, env, docname):

overrides sphinx.environment.collectors.EnvironmentCollector.clear_doc

Remove specified data of a document.

This method is called on the removal of the document.

def get_updated_docs(self, app, env):

overrides sphinx.environment.collectors.EnvironmentCollector.get_updated_docs

Return a list of docnames to re-read.

This methods is called after reading the whole of documents (experimental).

def merge_other(self, app, env, docnames, other):

overrides sphinx.environment.collectors.EnvironmentCollector.merge_other

Merge in specified data regarding docnames from a different BuildEnvironment object which coming from a subprocess in parallel builds.

def process_doc(self, app, doctree):

overrides sphinx.environment.collectors.EnvironmentCollector.process_doc

Build a TOC from the doctree and store it in the inventory.