- Home
- Get it
- Docs
- Extend/Develop

# Environment Collector API

class `sphinx.environment.collectors.``EnvironmentCollector`

  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.

  `clear_doc`(app, env, docname)

    Remove specified data of a document.

    This method is called on the removal of the document.

  `get_outdated_docs`(app, env, added, changed, removed)

    Return a list of docnames to re-read.

    This methods is called before reading the documents.

  `get_updated_docs`(app, env)

    Return a list of docnames to re-read.

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

  `merge_other`(app, env, docnames, other)

    Merge in specified data regarding docnames from a different BuildEnvironment object which coming from a subprocess in parallel builds.

  `process_doc`(app, doctree)

    Process a document and gather specific data from it.

    This method is called after the document is read.