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.18.tar.gz
(10.2 kB
view hashes)
Built Distribution
Close
Hashes for ansible_mdgen-0.0.18-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2f32329c71e280242377908c8c5fdb4c6cae3c8caa8d61adbb65106defedcb58 |
|
MD5 | 2101df9d7e142357cc25d7fb49e2d5a1 |
|
BLAKE2b-256 | 635b4d9750bb0c1d40abc60f9a5e3be3254ae3c9e558aa156abdb1fd69a0b028 |