sphinx.project.Project

class documentation

class Project: (source)

View In Hierarchy

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

Method __init__ Undocumented
Method discover Find all document files in the source directory and put them in :attr:`docnames`.
Method doc2path Return the filename for the document name.
Method path2doc Return the docname for the filename if the file is a document.
Method restore Take over a result of last build.
Instance Variable docnames Undocumented
Instance Variable source_suffix Undocumented
Instance Variable srcdir Undocumented
def __init__(self, srcdir, source_suffix): (source)

Undocumented

Parameters
srcdir:strUndocumented
source_suffix:dict[str, str]Undocumented
def discover(self, exclude_paths=(), include_paths=('**')): (source)

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

Parameters
exclude_paths:Iterable[str]Undocumented
include_paths:Iterable[str]Undocumented
Returns
set[str]Undocumented
def doc2path(self, docname, basedir=True): (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.

Parameters
docname:strUndocumented
basedir:boolUndocumented
Returns
strUndocumented
def path2doc(self, filename): (source)

Return the docname for the filename if the file is a document. *filename* should be absolute or relative to the source directory.

Parameters
filename:strUndocumented
Returns
str|NoneUndocumented
def restore(self, other): (source)

Take over a result of last build.

Parameters
other:ProjectUndocumented
docnames = (source)

Undocumented

source_suffix = (source)

Undocumented

srcdir = (source)

Undocumented