构建环境API¶

class sphinx.environment.BuildEnvironment[源代码]¶

Attributes

Per-document attributes

current_document¶

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

扩展可以使用 env.current_document 以存储与当前文档相关的数据，但应使用唯一的开头以避免名称冲突。

重要

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

current_document.default_domain: Domain | None¶: 当前文档的默认域。设定 default-domain 指令。

current_document.highlight_language: str¶: 语法突出显示的默认语言。设定 highlight 指令重写 highlight_language 配置值。

current_document._parser: Parser | None¶

This attribute is experimental and may be changed without notice.

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

Utility methods

doc2path(docname: str, base: bool = True) → _StrPath[源代码]¶

返回文档名称的文件名。

如果 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[源代码]¶

增列 filename 作为当前文档的依赖项。

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

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

new_serialno(category: str = '') → int[源代码]¶

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

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