Build environment API¶
- 
class sphinx.environment.BuildEnvironment[source]¶
- Attributes - 
srcdir¶
- Source directory. 
 - 
confdir¶
- Directory containing - conf.py.
 - 
doctreedir¶
- Directory for storing pickled doctrees. 
 - 
found_docs¶
- A set of all existing docnames. 
 - 
metadata¶
- Dictionary mapping docnames to “metadata” (see File-wide metadata). 
 - 
titles¶
- Dictionary mapping docnames to the docutils node for their main title. 
 - 
docname¶
- Returns the docname of the document currently being parsed. 
 - Utility methods - 
warn(docname, msg, lineno=None, **kwargs)[source]¶
- Emit a warning. - This differs from using - app.warn()in that the warning may not be emitted instantly, but collected for emitting all warnings after the update of the environment.
 - 
doc2path(docname, base=True, suffix=None)[source]¶
- Return the filename for the document name. - If base is True, return absolute path under self.srcdir. If base is None, return relative path to self.srcdir. If base is a path string, return absolute path under that. If suffix is not None, add it instead of config.source_suffix. 
 - 
relfn2path(filename, docname=None)[source]¶
- Return paths to a file referenced from a document, relative to documentation root and absolute. - In the input “filename”, absolute filenames are taken as relative to the source dir, while relative filenames are relative to the dir of the containing document. 
 - 
note_dependency(filename)[source]¶
- Add filename as a dependency of the current document. - This means that the document will be rebuilt if this file changes. - filename should be absolute or relative to the source directory. 
 
- 
