sphinx.project.Project

class documentation

class Project:

View In Hierarchy

A project is the source code set of the Sphinx document(s).
Method discover Find all document files in the source directory and put them in 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
Method __init__ Undocumented
def discover(self, exclude_paths=[]):
Find all document files in the source directory and put them in docnames.
Parameters
exclude​_paths:List[str]Undocumented
Returns
Set[str]Undocumented
def doc2path(self, 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.

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

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
Optional[str]Undocumented
def restore(self, other):
Take over a result of last build.
Parameters
other:ProjectUndocumented
docnames: set =

Undocumented

source_suffix =

Undocumented

srcdir =

Undocumented

def __init__(self, srcdir, source_suffix):

Undocumented

Parameters
srcdir:strUndocumented
source​_suffix:Dict[str, str]Undocumented