Skip to main content

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

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-docgenerator, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size ansible-docgenerator-0.1.0.tar.gz (3.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page