构建环境API¶

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

属性

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¶

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

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

实用方法

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

返回文件名的文件名。

如果*base*为真，则返回绝对路径self.srcdir. 如果*base*为False，则将相对路径返回到self..srcdir.

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

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

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

note_dependency(filename: str | PathLike[str], *, docname: str | None = None) → None[源代码]¶

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

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

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

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

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

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