class documentation

class TitleCollector(EnvironmentCollector):

View In Hierarchy

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.

Inherited from EnvironmentCollector:

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

Remove specified data of a document.

This method is called on the removal of the document.

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
docname:strUndocumented
def merge_other(self, app, env, docnames, other):
Merge in specified data regarding docnames from a different BuildEnvironment object which coming from a subprocess in parallel builds.
Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
docnames:Set[str]Undocumented
other:BuildEnvironmentUndocumented
def process_doc(self, app, doctree):
Add a title node to the document (just copy the first section title), and store that title in the environment.
Parameters
app:SphinxUndocumented
doctree:nodes.documentUndocumented