构建环境API

class sphinx.environment.BuildEnvironment

Attributes

app

参考 Sphinx （应用）对象。

config

参考 Config 对象。

project

目标项目。见 Project .

srcdir

源目录。

doctreedir

存储腌制doctrees的目录。

events

安 EventManager 对象。

found_docs

所有现有文档名的集合。

metadata

将文档名映射到“元数据”的字典（请参见 文件范围的元数据 ）

titles

将docname映射到其主标题的docutils节点的字典。

docname

返回当前正在分析的文档的docname。

实用方法

doc2path(docname: str, base: bool = True) → str

返回文档名的文件名。

如果 base 为True，则返回self.srcdir下的绝对路径。如果 base 为False，则返回self.srcdir的相对路径。

relfn2path(filename: str, docname: str | None = None) → tuple[str, str]

返回从文档引用的文件相对于文档根目录和绝对目录的路径。

在输入“文件名”中，绝对文件名被视为相对于源目录，而相对文件名则相对于包含文档的目录。

note_dependency(filename: str) → None

添加 文件名 作为当前文档的依赖项。

这意味着如果此文件更改，将重新生成文档。

文件名 应该是绝对的或相对于源目录的。

new_serialno(category: str = '') → int

返回序列号，例如索引项目标的序列号。

该编号保证在当前文档中是唯一的。

note_reread() → None

将当前文档添加到将在下次生成时自动重新读取的文档列表中。