Environment Collector API¶
-
class
sphinx.environment.collectors.
EnvironmentCollector
[fuente]¶ 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)[fuente]¶ Remove specified data of a document.
This method is called on the removal of the document.
-
get_outdated_docs
(app, env, added, changed, removed)[fuente]¶ Return a list of docnames to re-read.
This methods is called before reading the documents.
-
get_updated_docs
(app, env)[fuente]¶ Return a list of docnames to re-read.
This methods is called after reading the whole of documents (experimental).
-