生成环境接口

class sphinx.environment.BuildEnvironment

属性

app

对：class:`.Sphinx`（应用程序）对象的引用。

config

对：class:`.Config`对象的引用。

project

目标项目。参见：类：.Project。

srcdir

源目录

doctreedir

用于存储doctree的目录。

events

An:类：`.EventManager`对象。

found_docs

所有现有文件名的集合。

metadata

将docnames映射到“metadata”的字典（请参见：ref:metadata）。

titles

字典将docnames映射到docutils节点作为它们的主标题。

docname

返回当前正在分析的文档的文档名。

实用方法

doc2path(docname: str, base: bool = True) → str

返回文件名的文件名。

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

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

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

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

note_dependency(filename: str) → None

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

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

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

new_serialno(category: str = '') → int

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

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

note_reread() → None

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