项目 API¶

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

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

discover(exclude_paths: Iterable[str] = (), include_paths: Iterable[str] = ('**',)) → set[str][source]¶: 在源目录中查找所有文档文件，并将它们放入 docnames 中。

doc2path(docname: str, absolute: bool) → _StrPath[source]¶

返回文档名的文件名。

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

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

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

filename 应为绝对路径或相对于源目录的路径。