环境收集器API

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

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

它收集数据和存储 BuildEnvironment 作为数据库。 具体数据的示例包括图像,下载文件,部分标题,元数据,索引条目和toctrees等。

clear_doc(app: sphinx.application.Sphinx, env: sphinx.environment.BuildEnvironment, docname: str) → None[源代码]

删除文档的指定数据。

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

get_outdated_docs(app: sphinx.application.Sphinx, env: sphinx.environment.BuildEnvironment, added: Set[str], changed: Set[str], removed: Set[str]) → List[str][源代码]

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

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

get_updated_docs(app: sphinx.application.Sphinx, env: sphinx.environment.BuildEnvironment) → List[str][源代码]

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

在阅读完整个文档(实验)后调用此方法。

merge_other(app: sphinx.application.Sphinx, env: sphinx.environment.BuildEnvironment, docnames: Set[str], other: sphinx.environment.BuildEnvironment) → None[源代码]

合并来自不同`BuildEnvironment`对象的文档名的指定数据,该对象来自并行构建中的子进程。

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

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

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