环境收集器 API

class sphinx.environment.collectors.EnvironmentCollector

EnvironmentCollector 是每个文档中的特定数据收集器。

它收集数据并将 BuildEnvironment <sphinx.environment.BuildEnvironment> 作为数据库存储。 特定数据的示例是图像，下载文件，节标题，元数据，索引条目和 toctree 等。

clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) → None

删除文档中的指定数据。

在删除文档时调用此方法。

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

返回要重新读取的文档名称列表。

在阅读文档之前，将调用此方法。

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

返回要重新读取的文档名称列表。

阅读整个文档（实验）后，将调用此方法。

merge_other(app: Sphinx, env: BuildEnvironment, docnames: set[str], other: BuildEnvironment) → None

合并来自另一个“ BuildEnvironment”对象的，与文档名称有关的指定数据，该对象来自并行构建的子流程。

process_doc(app: Sphinx, doctree: nodes.document) → None

处理文档并从中收集特定数据。

读取文档后将调用此方法。