Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Simple tool for generating ansible role documentation

Project Description

# Ansible-DocGen
A python utility for generating Ansible files for roles

[![Build Status](](

* Ansible-DocGen is tested in `python3`

## Installation

### PIP

pip install ansible-docgeneration

**Note if you installed it from pip, you will need to use it like so from the command line:**

python -m docgen

### From Source

git clone
cd Ansible-DocGen
virtualenv-3.4 env -p python3
source env/bin/activate
pip install -r requirements.txt

## Usage

Usage: [OPTIONS]

# Basic usage:

#Specify a path to a role:
python --path=/path/to/ansible/role

#Specify a path to a role, and output the result to a file:
python --path=/path/to/ansible/role > /path/to/ansible/role/


* `--path` Path to your role (defaults to current directory)
* `--help` Show this message and exit.

## Test

.. coming soon

## Example output:

A role for settings up a django application

* **Required ansible version:** >= 1.2

## Required variables:
| Parameter | Example | Comment |
|`django_app_name`|`polls`|The name of your application. Typcially this will be the name of the folder containing your file|

## Optional variables:

| Parameter | Default |
|`manage_commands`|`['collectstatic', 'syncdb', 'migrate']`|

### Basic usage

- hosts: all
- django_app_name: polls
- { role: django, tags: django }


### TODO

* TODO: use pex to package virtualenv
* Unit testing
* Travis CI
* Better error handling

Release History

This version
History Node


Download Files

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

File Name & Hash SHA256 Hash Help Version File Type Upload Date
(3.0 kB) Copy SHA256 Hash SHA256
Source Oct 30, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting