プロジェクト API

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

A project is source code set of Sphinx document.

discover(exclude_paths: List[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)Optional[str][ソース]

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

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

restore(other: sphinx.project.Project)None[ソース]

Take over a result of last build.

docnames: Set[str]

The name of documents belongs to this project.

source_suffix

source_suffix. Same as source_suffix.

srcdir

ソースディレクトリ。