构建环境 API¶

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

属性

实用方法

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

返回文档名称的文件名.

如果 base 为 True,返回 self.srcdir 下的绝对路径.如果 base 为 False,返回相对于 self.srcdir 的相对路径.

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

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

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

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

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

这意味着如果此文件发生变化,文档将被重新构建.

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

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

返回一个序列号,例如用于索引条目目标.

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