Environment Collector API¶

class sphinx.environment.collectors.EnvironmentCollector[source]¶

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.

Note

This class essentially wraps a sub-set of Sphinx event callbacks.

clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) → None[source]¶

Remove specified data of a document.

This method is called on the removal of the document.

See also

env-purge-doc

get_outdated_docs(app: Sphinx, env: BuildEnvironment, added: set[str], changed: set[str], removed: set[str]) → list[str][source]¶

Return a list of docnames to re-read.

This method is called before reading the documents.

See also

env-get-outdated

get_updated_docs(app: Sphinx, env: BuildEnvironment) → list[str][source]¶

Return a list of docnames to re-read.

This method is called after reading the whole of documents.

See also

env-get-updated

merge_other(app: Sphinx, env: BuildEnvironment, docnames: set[str], other: BuildEnvironment) → None[source]¶: Merge in specified data regarding docnames from a different BuildEnvironment object which coming from a subprocess in parallel builds.

See also

env-merge-info

process_doc(app: Sphinx, doctree: nodes.document) → None[source]¶

Process a document and gather specific data from it.

This method is called after the document is read.

See also

doctree-read