Documenter.jl build "pipeline" named
Each stage of the pipeline performs an action on a
Documents.Document object. These actions may involve creating directory structures, expanding templates, running doctests, etc.
Checks that all documented objects are included in the document and runs doctests on all valid Julia code blocks.
Finds and sets URLs for each
@ref link in the document to the correct destinations.
Runs all the doctests in all docstrings and Markdown files.
The default document processing "pipeline", which consists of the following actions:
Executes a sequence of actions on each node of the parsed markdown files in turn.
IndexNodes with links.
Writes the document tree to the
Creates the correct directory layout within the
build folder and parses markdown files.
Checks if the page path
a should come before
b in a sorted list. Falls back to standard string sorting, except for prioritizing
index.md always comes first).
walk_navpages(visible, title, src, children, parent, doc)
This implementation is the de facto specification for the