Project API

class sphinx.project.Project(srcdir: str, source_suffix: Dict[str, str])[source]

A project is source code set of Sphinx document.

discover(exclude_paths: List[str] = [])Set[str][source]

Find all document files in the source directory and put them in docnames.

doc2path(docname: str, basedir: bool = True)str[source]

Return the filename for the document name.

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

path2doc(filename: str)Optional[str][source]

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

filename should be absolute or relative to the source directory.

restore(other: sphinx.project.Project)None[source]

Take over a result of last build.

docnames: Set[str]

The name of documents belongs to this project.


source_suffix. Same as source_suffix.


Source directory.