项目 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) → _StrPath[源代码]¶

返回文档名称的文件名.

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

path2doc(filename: str | PathLike[str]) → str | None[源代码]¶

如果文件是一个文档,则返回该文件的文档名.

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