Expanders
Documenter.expand_recursively — Method
Similar to expand(), but recursively calls itself on all descendants of node and applies NestedExpanderPipeline instead of ExpanderPipeline.
Documenter.writer_supports_ansicolor — Method
writer_supports_ansicolor(::Documenter.Writer)::BoolReturns whether the writer supports ANSI-colored output (true) or not (false).
This is usually relevant in Documenter blocks that execute code, like @example or @repl.
If true, these blocks will call show on the returned Julia object with color = true. If false, then show is called with color=false.
Documenter.Expanders.AutoDocsBlocks — Type
Parses each code block where the language is @autodocs and replaces it with all the docstrings that match the provided key/value pairs Modules = ... and Order = ....
```@autodocs
Modules = [Foo, Bar]
Order = [:function, :type]
```Documenter.Expanders.ContentsBlocks — Type
Parses each code block where the language is @contents and replaces it with a nested list of all Header nodes in the generated document. The pages and depth of the list can be set using Pages = [...] and Depth = N where N is and integer.
```@contents
Pages = ["foo.md", "bar.md"]
Depth = 1
```The default Depth value is 2.
Documenter.Expanders.DocsBlocks — Type
Parses each code block where the language is @docs and evaluates the expressions found within the block. Replaces the block with the docstrings associated with each expression.
```@docs
Documenter
makedocs
deploydocs
```Documenter.Expanders.EvalBlocks — Type
Parses each code block where the language is @eval and evaluates it's content. Replaces the block with the value resulting from the evaluation. This can be useful for inserting generated content into a document such as plots.
```@eval
using PyPlot
x = linspace(-π, π)
y = sin(x)
plot(x, y, color = "red")
savefig("plot.svg")
Markdown.parse("")
```Documenter.Expanders.ExampleBlocks — Type
Parses each code block where the language is @example and evaluates the parsed Julia code found within. The resulting value is then inserted into the final document after the source code.
```@example
a = 1
b = 2
a + b
```Documenter.Expanders.ExpanderPipeline — Type
The default node expander "pipeline", which consists of the following expanders:
TrackHeadersMetaBlocksDocsBlocksAutoDocsBlocksEvalBlocksIndexBlocksContentsBlocksExampleBlocksSetupBlocksREPLBlocks
Documenter.Expanders.IndexBlocks — Type
Parses each code block where the language is @index and replaces it with an index of all docstrings spliced into the document. The pages that are included can be set using a key/value pair Pages = [...] such as
```@index
Pages = ["foo.md", "bar.md"]
```Documenter.Expanders.MetaBlocks — Type
Parses each code block where the language is @meta and evaluates the key/value pairs found within the block, i.e.
```@meta
CurrentModule = Documenter
DocTestSetup = quote
using Documenter
end
```Documenter.Expanders.REPLBlocks — Type
Similar to the ExampleBlocks expander, but inserts a Julia REPL prompt before each toplevel expression in the final document.
Documenter.Expanders.SetupBlocks — Type
Similar to the ExampleBlocks expander, but hides all output in the final document.