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.19.tar.gz
(10.3 kB
view hashes)
Built Distribution
Close
Hashes for ansible_mdgen-0.0.19-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 392ab6fb6ae05b2a6b080b04cd55ffb8773165b8d44bb18027368d9bccaeaf0a |
|
MD5 | 9e19a7fb9ed69dcca83306305c0e9a32 |
|
BLAKE2b-256 | 9c6717bda907888edbb22e3440d93c30315e726ccde32fe1851ed31f09c63b40 |