A python package to automate documentation generation for ansible roles.
Project description
ansible-mdgen
Ansible-mdgen is a package used to auto generate documentation for an ansible role.
To install
pip install ansible-mdgen
To run
Call ansible-mdgen passing in the path to the role
ansible-mdgen <path_to_role>
Documentation
See here for full documentation.
Credits
The idea for this project is based on (and includes some code from) ansible-autodoc by Andres Bott so credit to him for his work.
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
ansible-mdgen-0.0.14.tar.gz
(10.0 kB
view details)
Built Distribution
File details
Details for the file ansible-mdgen-0.0.14.tar.gz.
File metadata
- Download URL: ansible-mdgen-0.0.14.tar.gz
- Upload date:
- Size: 10.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c66be17c92a90f2f776d74e988116a59c4b20078397b940a69cbe745317c3da7 |
|
| MD5 | 920eec8b86d38ab901fe8071cf2f6469 |
|
| BLAKE2b-256 | a2380551c0cacd56cfee3bbb2c939e8035d01b9743c8cde61847820bcdbfb9de |
File details
Details for the file ansible_mdgen-0.0.14-py3-none-any.whl.
File metadata
- Download URL: ansible_mdgen-0.0.14-py3-none-any.whl
- Upload date:
- Size: 15.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.8.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 215ef4473773b30792fb020b1e9bb7b52cb3fbe7767b2af9fb3c74bf94b54d19 |
|
| MD5 | 644d24844cc74167186d4956cb057ca7 |
|
| BLAKE2b-256 | f2415475768903a9e708bdbc6434dc2a5670d65392aedc6ed7c984eda8af5a41 |
