Reference

Docstrings for DocumenterQuarto.

generate

generate(; title, type, api)

Generate a documentation site from a default template.

DocumenterQuarto

Utilities and templates for documenting your Julia package with Quarto!

Exports

autodoc

autodoc(mod, symbols; delimiter)

Automatically process and return documentation for symbols in the provided module. If no symbols are provided, all exported symbols are used. The delimiter keyword argument is printed in between each documented name.

Example

import LinearAlgebra
DocumenterQuarto.autodoc(LinearAlgebra)

doc

doc(mod, sym; header)

Return the documentation string associated with the provided name, with substitutions to allow for compatibility with Quarto.

Example

doc(Main, :Int)

DocumenterQuarto.@doc

Return documentation for a Julia symbol as Quarto Markdown.

Example

This macro takes the output of Base.Docs.@doc (available by-default in Julia code) and calls DocumenterQuarto.process on the result to convert the docstring to Quarto Markdown.

import DocumenterQuarto: @doc

@doc @time