构建环境API

class sphinx.environment.BuildEnvironment[source]

属性

app

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

config

对 Config 对象的引用。

project

目标项目。请参阅 Project。

srcdir

源目录。

doctreedir

存储序列化文档树的目录。

events

一个 EventManager 对象。

found_docs

所有现有 docname 的集合。

metadata

将 docname 映射到“元数据”的字典（请参阅文件级元数据）。

titles

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

docname

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

parser

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

按文档属性

current_document

读取文档时的临时数据存储。

扩展可以使用 env.current_document 提供的映射接口来存储与当前文档相关的数据，但应使用唯一前缀以避免命名冲突。

重要

只有以下属性构成公共 API。类型本身以及任何方法或其他属性仍为私有、实验性，并将在不通知的情况下更改或删除。

current_document.docname: str

当前文档的文档名称（“docname”）。

current_document.default_role: str

当前文档的默认角色。由 default-role 指令设置。

current_document.default_domain: Domain | None

当前文档的默认域。由 default-domain 指令设置。

current_document.highlight_language: str

语法高亮的默认语言。由 highlight 指令设置，以覆盖 highlight_language 配置值。

current_document._parser: Parser | None

此属性是实验性的，可能在不通知的情况下更改。

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

实用方法

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

返回文档名称的文件名。

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

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

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

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

note_dependency(filename: str | PathLike[str], *, docname: str | None = None) → None[source]

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

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

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

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

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

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

note_reread() → None[source]

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