This release is a pre-release and may not be stable for production use.
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.
Metadata
Release files for mkdocs-yaarg-plugin 0.0.1a5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-yaarg-plugin-0.0.1a5.tar.gz | 7.1 kB | Without provenance | Details for mkdocs-yaarg-plugin-0.0.1a5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_yaarg_plugin-0.0.1a5-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_yaarg_plugin-0.0.1a5-py3-none-any.whl |
Total release size: 16.0 kB
Release files / mkdocs-yaarg-plugin-0.0.1a5.tar.gz
| Download URL | mkdocs-yaarg-plugin-0.0.1a5.tar.gz |
|---|---|
| Size | 7.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
209a7f1953a348959bf7b934651ded6532f733d1bf030b72de3294ed9bc7e3e2
|
|
BLAKE2b-256 checksum How to use checksums |
53d8ceebd904ca5f0e9faed95a69f71be78d02a6fee2d3c75d02826056cb56eb
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10
|
Release files / mkdocs_yaarg_plugin-0.0.1a5-py3-none-any.whl
| Download URL | mkdocs_yaarg_plugin-0.0.1a5-py3-none-any.whl |
|---|---|
| Size | 9.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
60136125585dd22ff0ce8d2de272388fbcb9313d12735d1602a37dd42a59f7da
|
|
BLAKE2b-256 checksum How to use checksums |
587df368bcc0dab0cf6df434ff2d7871cd971aec145db96d52fa076b1ac6273f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.7.10
|
Security for mkdocs-yaarg-plugin 0.0.1a5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.