sphinx.environment.collectors.EnvironmentCollector

class documentation

class EnvironmentCollector: (source)

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 :py:class:`BuildEnvironment <sphinx.environment.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 disable Undocumented
Method enable Undocumented
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.
Instance Variable listener_ids Undocumented
def clear_doc(self, app, env, docname): (source)
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 disable(self, app): (source)

Undocumented

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

Undocumented

Parameters
app:SphinxUndocumented
def get_outdated_docs(self, app, env, added, changed, removed): (source)

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): (source)
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): (source)
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): (source)
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
listener_ids = (source)

Undocumented