This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
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

Release History


This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
ansible-docgenerator-0.1.0.tar.gz (3.0 kB) Copy SHA256 Checksum SHA256 Source Oct 30, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development 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