构建环境 API¶

class sphinx.environment.BuildEnvironment[source]¶

属性

每个文档的属性

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[source]¶

返回文档名称的文件名。

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

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

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

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

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

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

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

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

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

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

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