构建环境 API

class sphinx.environment.BuildEnvironment[source]

属性

app

指向 Sphinx（应用程序）对象的引用。

config

指向 Config 对象的引用。

project

目标项目。参见 Project。

srcdir

源代码目录。

doctreedir

用于存储腌制 doctree 的目录。

events

一个 EventManager 对象。

found_docs

所有现有 docname 的集合。

metadata

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

titles

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

docname

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

parser

返回用于解析当前文档的解析器。

实用方法

doc2path(docname: str, base: bool = True) → _StrPath[source]

返回文档名称的文件名。

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

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

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

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

note_dependency(filename: str) → None[source]

将 filename 添加为当前文档的依赖项。

这意味着如果此文件发生更改，则将重新构建文档。

filename 应为绝对路径或相对于源目录的路径。

new_serialno(category: str = '') → int[source]

返回一个序列号，例如用于索引条目目标。

该数字保证在当前文档中是唯一的。

note_reread() → None[source]

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