Yet Another API Reference Generator plugin for MKDocs.
Project description
mkdocs-yaarg-plugin
Yet Another API Reference Generator plugin for MKDocs.
Installation
Install package from PyPI,
pip install mkdocs-yaarg-plugin
then add it to mkdocs.yml
:
plugins:
- yaarg
Usage
# API Reference
::: some/filepath/to/module.py
See documentation for other options and details.
Why
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for mkdocs-yaarg-plugin-0.0.1a5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 209a7f1953a348959bf7b934651ded6532f733d1bf030b72de3294ed9bc7e3e2 |
|
MD5 | ee9b813d8962a1a43366cfc946cb2467 |
|
BLAKE2b-256 | 53d8ceebd904ca5f0e9faed95a69f71be78d02a6fee2d3c75d02826056cb56eb |
Close
Hashes for mkdocs_yaarg_plugin-0.0.1a5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 60136125585dd22ff0ce8d2de272388fbcb9313d12735d1602a37dd42a59f7da |
|
MD5 | f9e5e1292c6889e7f0a029116a05cdbc |
|
BLAKE2b-256 | 587df368bcc0dab0cf6df434ff2d7871cd971aec145db96d52fa076b1ac6273f |