Skip to main content

A python package to automate documentation generation for ansible roles.

Project description

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.

Project details


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)

Uploaded Source

Built Distribution

ansible_mdgen-0.1.1-py3-none-any.whl (16.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page