生成ansible角色文档的简单工具
ansible-docgenerator的Python项目详细描述
#ansible docgen
一个python实用程序，用于为角色生成ansible readme.md文件
[！[构建状态]（https://travis-ci.org/toast38coza/ansible-docgen.svg？branch=master）（https://travis ci.org/toast38coza/ansible docgen）
*ansible docgen在“python3”中进行测试
您将需要像这样从命令行使用它：**
从
`````
git clone git@github.com:toast38coza/ansible docgen.git
cd ansible docgen
virtualenv-3.4 env-p python3
source-env/bin/activate
p-env/bin/activate
pip install-r-install-r-requirements.txt
`` `````````````
##用法
```
用法：docgen.py[选项]
[路径/ / /可/角色/自述]，MD
'BR/> BR/> **选项：**BR/> BR/> *（路径到你的角色）（默认为当前目录）
*帮助“显示此信息并退出”BR/> BR/>测试
BR/>即将到来的
示例输出：
>设置django应用程序的角色
***必需的Ansible版本：***>；=1.2
必需变量：
；
参数示例注释
*******必需的Anjango应用程序的安装name`` polls``应用程序的名称。通常，这是包含设置的文件夹的名称。py文件
可选变量：
参数默认值|
|--------------|----------|
|`django_settings_directory_path`|`{{django_app_path}}/{{django_project_name}}`|
|`django_gunicorn_workers`|`2`|
|`django_venv_path`|`/srv/venvs/{{django_app_name}}`|
|`django_media_path`|`/srv/{{django_app_name}}/media`|
|`django_http_port`|`8000`|
|`manage_commands`|`['collectstatic', “同步数据库”，'migrate']`|
|`django_settings_vars`|`[]`|
|`django_static_path`|`/srv/{{django_app_name}}/static`|
|`django_log_path`|`/var/log/{{django_app_name}}`|
|`django_requirements_location`|`{{django_app_path}}/requirements.txt`|
|`django_env_vars`|`[]`|
|`django_version`|`1.8`|
|`django_app_path`|`/var/www/{{django_app_name}}`|
|`django_github_version`|`master`|
### Basic usage
```
- hosts: all
vars:
- django_app_name: polls
roles:
- { role: django, tags: django }
```
### TODO
* TODO: use pex to package virtualenv
* Unit testing
* Travis CI
* Better error handling
一个python实用程序，用于为角色生成ansible readme.md文件
[！[构建状态]（https://travis-ci.org/toast38coza/ansible-docgen.svg？branch=master）（https://travis ci.org/toast38coza/ansible docgen）
*ansible docgen在“python3”中进行测试
您将需要像这样从命令行使用它：**
从
`````
git clone git@github.com:toast38coza/ansible docgen.git
cd ansible docgen
virtualenv-3.4 env-p python3
source-env/bin/activate
p-env/bin/activate
pip install-r-install-r-requirements.txt
`` `````````````
##用法
```
用法：docgen.py[选项]
[路径/ / /可/角色/自述]，MD
'BR/> BR/> **选项：**BR/> BR/> *（路径到你的角色）（默认为当前目录）
*帮助“显示此信息并退出”BR/> BR/>测试
BR/>即将到来的
示例输出：
>设置django应用程序的角色
***必需的Ansible版本：***>；=1.2
必需变量：
；
参数示例注释
*******必需的Anjango应用程序的安装name`` polls``应用程序的名称。通常，这是包含设置的文件夹的名称。py文件
可选变量：
参数默认值|
|--------------|----------|
|`django_settings_directory_path`|`{{django_app_path}}/{{django_project_name}}`|
|`django_gunicorn_workers`|`2`|
|`django_venv_path`|`/srv/venvs/{{django_app_name}}`|
|`django_media_path`|`/srv/{{django_app_name}}/media`|
|`django_http_port`|`8000`|
|`manage_commands`|`['collectstatic', “同步数据库”，'migrate']`|
|`django_settings_vars`|`[]`|
|`django_static_path`|`/srv/{{django_app_name}}/static`|
|`django_log_path`|`/var/log/{{django_app_name}}`|
|`django_requirements_location`|`{{django_app_path}}/requirements.txt`|
|`django_env_vars`|`[]`|
|`django_version`|`1.8`|
|`django_app_path`|`/var/www/{{django_app_name}}`|
|`django_github_version`|`master`|
### Basic usage
```
- hosts: all
vars:
- django_app_name: polls
roles:
- { role: django, tags: django }
```
### TODO
* TODO: use pex to package virtualenv
* Unit testing
* Travis CI
* Better error handling
欢迎加入QQ群-->： 979659372
