环境收集器 API¶

class sphinx.environment.collectors.EnvironmentCollector[源代码]¶

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

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

备注

此类本质上是 Sphinx 事件回调的子集的包装。

clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) → None[源代码]¶

删除文档中的指定数据。

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

参见

env-purge-doc

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

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

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

参见

env-get-outdated

get_updated_docs(app: Sphinx, env: BuildEnvironment) → list[str][源代码]¶

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

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

参见

env-get-updated

merge_other(app: Sphinx, env: BuildEnvironment, docnames: Set[str], other: BuildEnvironment) → None[源代码]¶: 合并来自另一个 BuildEnvironment 对象的，与文档名称有关的指定数据，该对象来自并行构建的子流程。

参见

env-merge-info

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

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

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

参见