Skip to content

autoapi

Discover Python files and generate API reference pages. Native support was added in Zensical 0.0.66.

Document a package as it changes; build a reference for a collection of small modules.

Try it

Open the autoapi example.

Generated package index

Open the API section to see the discovered package.

Function documentation

Open samplelib to see its greet function extracted from its 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