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.15.tar.gz
(10.0 kB
view hashes)
Built Distribution
Close
Hashes for ansible_mdgen-0.0.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db47d1beb1a44de65f89764b93ba834a93cb472756f8d25fbda1dd411009d516 |
|
MD5 | 539d390ecf6a7182646fb719d47fabe3 |
|
BLAKE2b-256 | 6075ddd0e8cfd850e3a01482c49c0ad7d2a19b4d0ea295ce5d85cf3ef8fb2039 |