Yet Another API Reference Generator plugin for MKDocs.
Install package from PyPI,
pip install mkdocs-yaarg-plugin
then add it to mkdocs.yml
:
plugins:
- yaarg
# API Reference
::: some/filepath/to/module.py
See documentation for other options and details.
As a Python docstring documentation generator:
- Fast & static
yaarg
's default Python generator does not depend on any runtime data.
Executing Python code to build a documentation is simply unnecessary, slow and potentially dangerous.
As a general API reference generator:
- Language agnostic
- Unopinionated on how markdown output should look like
So that one can easily exploit exisiting documentation tooling in their eco-system.