Skip to content

mkdocstrings

Build API reference sections from source docstrings. Native support was added in Zensical 0.0.11.

Document a public function next to a tutorial; generate class reference material from maintained source.

Try it

Open the mkdocstrings example.

Function signature

The greet directive renders a Python signature.

Docstring

Its arguments and return value come from the function’s source docstring.

Source and configuration

The configuration and example Markdown are available in the repository. Other files in that directory supply the example’s fixtures.

Zensical compatibility and settings · Plugin documentation