项目API

class sphinx.project.Project(srcdir: str | os.PathLike[str], source_suffix: Iterable[str])

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

discover(exclude_paths: Iterable[str] = (), include_paths: Iterable[str] = ('**',)) → set[str]

在源目录中查找所有文档文件并将其放入 docnames .

doc2path(docname: str, absolute: bool) → str

返回文档名的文件名。

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

path2doc(filename: str | PathLike[str]) → str | None

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

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

restore(other: Project) → None

接管上次生成的结果。

docnames: set[str]

属于此项目的文档的名称。

source_suffix

来源于后缀。等同于 source_suffix .

srcdir

源目录。