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.1.1.tar.gz
(11.4 kB
view hashes)
Built Distribution
Close
Hashes for ansible_mdgen-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23ee7ec271b83a7d07ba1f32fc05acb4054b7539ed3d3b71090904dd7327ba0a |
|
MD5 | 31513c19979a8c2fd50ad3bdb0cab235 |
|
BLAKE2b-256 | fc3756c0c93eb5318b0dd302fbc7f18281cd9a05c92d826b9f1dc2ead97066cb |