sphinx.environment.collectors.title.TitleCollector

class documentation

class TitleCollector(EnvironmentCollector):

title collector for sphinx.environment.

Method	`clear_doc`	Remove specified data of a document.
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`	Add a title node to the document (just copy the first section title), and store that title in the environment.

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

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

Add a title node to the document (just copy the first section title), and store that title in the environment.