构建环境API

class sphinx.environment.BuildEnvironment[源代码]

属性

app

引用 Sphinx (应用程序) 对象。

config

引用 Config 对象。

project

目标项目。见 。Project

srcdir

源目录。

doctreedir

存储酸洗 doctree 的目录。

found_docs

一组所有现有的文档名称。

metadata

字典映射文档名称为 “元数据” (参见 File-wide metadata) 。

titles

字典将docnames映射到docutils节点以获取其主标题。

docname

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

实用方法

doc2path(docname: str, base: Union[bool, str] = True, suffix: str = None) → str[源代码]

返回文档名称的文件名。

如果 base 为True,则返回 self.srcdir 下的绝对路径。如果 base 为 None ,则返回 self.srcdir 的相对路径。 如果 base 是路径字符串,则返回其下的绝对路径。如果 suffix 不是None,则添加它而不是 config.source_suffix 。

relfn2path(filename: str, docname: str = None) → Tuple[str, str][源代码]

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

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

note_dependency(filename: str) → None[源代码]

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

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

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

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

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

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

note_reread() → None[源代码]

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