环境收集器 API¶

class sphinx.environment.collectors.EnvironmentCollector[source]¶

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

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

注意

此类本质上包装了 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]¶

返回需要重新读取的 docnames 列表。

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

参见

env-get-outdated

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

返回需要重新读取的 docnames 列表。

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

参见

env-get-updated

merge_other(app: Sphinx, env: BuildEnvironment, docnames: set[str], other: BuildEnvironment) → None[source]¶: 将来自不同子进程的 BuildEnvironment 对象（来自并行构建）的指定数据合并到指定 docnames 中。

参见

env-merge-info

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

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

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

参见