/ansible-mdgen

Python package to automate documentation generation for Ansible

Primary LanguagePythonMIT LicenseMIT

ansible-mdgen

<CircleCI>

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.