环境收集器 API

class sphinx.environment.collectors.EnvironmentCollector[source]

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

它收集数据并将 BuildEnvironment 存储为数据库。特定数据的示例包括图像、下载文件、章节标题、元数据、索引条目和 toctree 等。

注意

此类本质上封装了 Sphinx 事件回调 的子集。

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

移除文档的指定数据。

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

另请参阅

env-purge-doc

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

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

此方法在读取文档之前调用。

另请参阅

env-get-outdated

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

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

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

另请参阅

env-get-updated

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

从并行构建中子进程的不同 BuildEnvironment 对象合并关于文档名的指定数据。

另请参阅

env-merge-info

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

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

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

另请参阅

doctree-read