构建环境API¶
-
class
sphinx.environment.
BuildEnvironment
[源代码]¶ 属性
-
project
¶ 目标项目。见
。Project
。
-
srcdir
¶ 源目录。
-
doctreedir
¶ 存储酸洗 doctree 的目录。
-
found_docs
¶ 一组所有现有的文档名称。
-
metadata
¶ 字典映射文档名称为 “元数据” (参见 File-wide metadata) 。
-
titles
¶ 字典将docnames映射到docutils节点以获取其主标题。
-
docname
¶ 返回当前正在解析的文档的docname。
实用方法
-
doc2path
(docname, base=True, suffix=None)[源代码]¶ 返回文档名称的文件名。
如果 base 为True,则返回 self.srcdir 下的绝对路径。如果 base 为 None ,则返回 self.srcdir 的相对路径。 如果 base 是路径字符串,则返回其下的绝对路径。如果 suffix 不是None,则添加它而不是 config.source_suffix 。
-