项目API

class sphinx.project.Project(srcdir, source_suffix)[源代码]

项目是Sphinx文档的源代码集。

discover(exclude_paths=[])[源代码]

查找源目录中的所有文档文件并将它们放在 docnames 中。

doc2path(docname, basedir=True)[源代码]

返回文档名称的文件名。

如果 basedir 为True,则返回绝对路径。否则,返回作为源目录的相对路径。

path2doc(filename)[源代码]

如果文件是文档,则返回文件名的docname。

filename should be absolute or relative to the source directory.

restore(other)[源代码]

接管上一次构建的结果。

docnames = None

文档名称属于此项目。

source_suffix = None

source_suffix。与 source_suffix 相同。

srcdir = None

源目录。