环境收集器API

class sphinx.environment.collectors.EnvironmentCollector

环境收集器是来自每个文档的特定数据收集器。

它收集数据并存储 BuildEnvironment 作为数据库。具体数据的例子包括图像、下载文件、节标题、元数据、索引条目和目录树等。

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

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

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