The environment in which the ReST files are translated. Stores an inventory of cross-file targets and provides doctree transformations to resolve links to them.
Initialize self. See help(type(self)) for accurate signature.
Apply all post-transforms.
Do consistency checks.
Remove all traces of a source file in the inventory.
create_index(builder[, group_entries, _fixre])
doc2path(docname[, base, suffix])
Return the filename for the document name.
Find all source files in the source dir and put them in self.found_docs.
get_and_resolve_doctree(docname, builder[, …])
Read the doctree from the pickle, resolve cross-references and toctrees and return it.
Read the doctree for a file from the pickle and return it.
Return the domain instance with the specified name.
Return (added, changed, removed) sets.
Return a TOC nodetree – for use on the same page only!
get_toctree_for(docname, builder, collapse, …)
Return the global TOC nodetree.
merge_info_from(docnames, other, app)
Merge global information gathered about docnames while reading them from the other environment.
Return a serial number, e.g.
Add filename as a dependency of the current document.
Add filename as a included from other document.
Add the current document to the list of documents that will automatically be re-read at the next build.
Note a TOC tree directive in a document and gather information about file relations from it.
note_versionchange(type, version, node, lineno)
Return the docname for the filename if the file is document.
Prepare to set up environment for reading.
Return paths to a file referenced from a document, relative to documentation root and absolute.
resolve_references(doctree, fromdocname, builder)
resolve_toctree(docname, builder, toctree[, …])
Resolve a toctree node into individual bullet lists with titles as items, returning None (if no containing titles are found) or a new node.
This sets the doctree versioning method for this environment.
Set up BuildEnvironment object.
update(config, srcdir, doctreedir)
warn(docname, msg[, lineno])
Emit a warning.
warn_node(msg, node, **kwargs)
warn(), but with source information taken from node.
Returns the docname of the document currently being parsed.