プロジェクト API¶

class sphinx.project.Project(srcdir: str, source_suffix: dict[str, str])[ソース]¶

A project is the source code set of the Sphinx document(s).

discover(exclude_paths: Iterable[str] = (), include_paths: Iterable[str] = ('**',)) → set[str][ソース]¶: Find all document files in the source directory and put them in docnames.

doc2path(docname: str, basedir: bool = True) → str[ソース]¶

ドキュメント名に関連するファイル名を返します。

If basedir is True, return as an absolute path. Else, return as a relative path to the source directory.

path2doc(filename: str) → str | None[ソース]¶

Return the docname for the filename if the file is a document.

filenameは絶対パスもしくは、ソースディレクトリからの相対パスで指定する必要があります。