Project 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 應該是絕對路徑或相對於原始碼目錄的路徑。