Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Generate documenting README.md files for Ansible roles

Project description

Repository license PyPI package Travis CI result Documentation status Support badge

Generate documenting README files for Ansible roles

The time is still ripe (tonk, June 2016 (!)) for standardised role documentation but in the absence of this the Ansible community must step up and try to formalise what is already being done and what should be done to document roles.

Ansible-Readme is a tool which aims to enable the Ansible community to try and come to a consensus on how we would like the standardisation of role documentation to look like and what tools we need to do that. It does not intend to be the last word but instead proposes an approach based on the needs of the author. New approaches are welcome (let us implement them or at least document them). In short, this is an experiment and your participation is required.

The core principle is this: we need to generate the documentation based on the role directory structure. This arises out of applying the “Do One Thing and Do It Well” philosophy to developing roles. And as we have seen in practice, the maintenance burden increases dramatically with this approach as the number of roles increases. Whatever hand written documentation there is can quickly get out of sync or sometimes be abandoned altogether.

Please join the discussion on the issue tracker.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ansible-readme, version 1.0.5
Filename, size File type Python version Upload date Hashes
Filename, size ansible_readme-1.0.5-py3.7.egg (23.3 kB) File type Egg Python version 3.7 Upload date Hashes View hashes
Filename, size ansible_readme-1.0.5-py3-none-any.whl (23.5 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size ansible-readme-1.0.5.tar.gz (26.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page