sphinx.environment.collectors.EnvironmentCollector

class documentation

class EnvironmentCollector:

Known subclasses: sphinx.environment.collectors.asset.DownloadFileCollector, sphinx.environment.collectors.asset.ImageCollector, sphinx.environment.collectors.dependencies.DependenciesCollector, sphinx.environment.collectors.metadata.MetadataCollector, sphinx.environment.collectors.title.TitleCollector, sphinx.environment.collectors.toctree.TocTreeCollector

View In Hierarchy

An EnvironmentCollector is a specific data collector from each document.

It gathers data and stores BuildEnvironment as a database. Examples of specific data would be images, download files, section titles, metadatas, index entries and toctrees, etc.

Method clear​_doc Remove specified data of a document.
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 merge​_other Merge in specified data regarding docnames from a different BuildEnvironment object which coming from a subprocess in parallel builds.
Method process​_doc Process a document and gather specific data from it.
Method disable Undocumented
Method enable Undocumented
Instance Variable listener​_ids Undocumented
def clear_doc(self, app, env, docname):
overridden in sphinx.environment.collectors.asset.DownloadFileCollector, sphinx.environment.collectors.asset.ImageCollector, sphinx.environment.collectors.dependencies.DependenciesCollector, sphinx.environment.collectors.metadata.MetadataCollector, sphinx.environment.collectors.title.TitleCollector, sphinx.environment.collectors.toctree.TocTreeCollector

Remove specified data of a document.

This method is called on the removal of the document.

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
docname:strUndocumented
def get_outdated_docs(self, app, env, added, changed, removed):

Return a list of docnames to re-read.

This methods is called before reading the documents.

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
added:Set[str]Undocumented
changed:Set[str]Undocumented
removed:Set[str]Undocumented
Returns
List[str]Undocumented
def get_updated_docs(self, app, env):
overridden in sphinx.environment.collectors.toctree.TocTreeCollector

Return a list of docnames to re-read.

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

Parameters
app:SphinxUndocumented
env:BuildEnvironmentUndocumented
Returns
List[str]Undocumented
def merge_other(self, app, env, docnames, other):
overridden in sphinx.environment.collectors.asset.DownloadFileCollector, sphinx.environment.collectors.asset.ImageCollector, sphinx.environment.collectors.dependencies.DependenciesCollector, sphinx.environment.collectors.metadata.MetadataCollector, sphinx.environment.collectors.title.TitleCollector, sphinx.environment.collectors.toctree.TocTreeCollector
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):
overridden in sphinx.environment.collectors.asset.DownloadFileCollector, sphinx.environment.collectors.asset.ImageCollector, sphinx.environment.collectors.dependencies.DependenciesCollector, sphinx.environment.collectors.metadata.MetadataCollector, sphinx.environment.collectors.title.TitleCollector, sphinx.environment.collectors.toctree.TocTreeCollector

Process a document and gather specific data from it.

This method is called after the document is read.

Parameters
app:SphinxUndocumented
doctree:nodes.documentUndocumented
def disable(self, app):

Undocumented

Parameters
app:SphinxUndocumented
def enable(self, app):

Undocumented

Parameters
app:SphinxUndocumented
listener_ids =

Undocumented