环境收集器 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[源代码]¶

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

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

参见