Project API

class sphinx.project.Project(srcdir, source_suffix)

A project is source code set of Sphinx document.

discover(exclude_paths=[])

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

doc2path(docname, basedir=True)

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)

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

filename should be absolute or relative to the source directory.

restore(other)

Take over a result of last build.

docnames = None

The name of documents belongs to this project.

source_suffix = None

source_suffix. Same as source_suffix.

srcdir = None

Source directory.