环境收集器 API¶

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

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

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

注意

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

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

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

另请参阅