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.
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
ansible-mdgen-0.0.17.tar.gz
(10.2 kB
view hashes)
Built Distribution
Close
Hashes for ansible_mdgen-0.0.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31ffb0b7a49040286ab85ac9b8c7187c88f45cd694c2893981722afaedb1c969 |
|
MD5 | 4f37c5ea4dcc0638de64b7269d2ecdc8 |
|
BLAKE2b-256 | 605e5f7c55ba9f3c5e7f3fafee6cec9603ea18efcd359dc72c0f1ddbed8b9a76 |