环境收集器API¶
- class sphinx.environment.collectors.EnvironmentCollector[源代码]¶
环境收集器是每个文档中的特定数据收集器。
它收集数据并存储
BuildEnvironment
作为一个数据库。特定数据的示例是图像、下载文件、小节标题、元数据、索引条目和toctree等。备注
此类本质上包装了 Sphinx event callbacks .
- get_outdated_docs(app: Sphinx, env: BuildEnvironment, added: set[str], changed: set[str], removed: set[str]) list[str] [源代码]¶
返回要重新阅读的文档名列表。
在阅读文档之前调用此方法。
- merge_other(app: Sphinx, env: BuildEnvironment, docnames: Set[str], other: BuildEnvironment) None [源代码]¶
合并到指定的有关来自不同 BuildEnvironment 来自并行生成中的子进程的对象。