Represents an entire document.
Page-local values such as current module that are shared between nodes in a page.
Private state used to control the generation process.
Element in the navigation tree of a document, containing navigation references to other page, reference to the
Page object etc.
Represents a single markdown file.
User-specified values used to control the generation process.
Plugin type for
T stored in
T was passed to
makedocs, the passed type will be returned. Otherwise, a new
T object will be created using the default constructor
Constructs a list of the ancestors of the
navnode (inclding the
navnode itself), ordered so that the root of the navigation tree is the first and
navnode itself is the last item.
IndexNodes of the
document with links.
This can only be done after all the blocks have been expanded (and nodes constructed), because the items have to exist before we can gather the links to those items.
walk(f, meta, element)
element and any of its child elements.
meta is a
Dict containing metadata such as current module.