All Projects → thedavidwhiteside → ansible-docgen

thedavidwhiteside / ansible-docgen

Licence: MIT license
Generate documentation from annotated Ansible Playbooks and Roles

Programming Languages

python
139335 projects - #7 most used programming language
Jinja
831 projects
shell
77523 projects

Projects that are alternatives of or similar to ansible-docgen

annotate
Create 3D labelled bounding boxes in RViz
Stars: ✭ 104 (+70.49%)
Mutual labels:  annotation
concrete-python
Python modules and scripts for working with Concrete, a data serialization format for NLP
Stars: ✭ 19 (-68.85%)
Mutual labels:  annotation
DRAM
Distilled and Refined Annotation of Metabolism: A tool for the annotation and curation of function for microbial and viral genomes
Stars: ✭ 159 (+160.66%)
Mutual labels:  annotation
automated-testing-playbook
A set of principles, practices, idioms, and strategies pertaining to automated software testing and its adoption
Stars: ✭ 50 (-18.03%)
Mutual labels:  playbook
bac-genomics-scripts
Collection of scripts for bacterial genomics
Stars: ✭ 39 (-36.07%)
Mutual labels:  annotation
prodoc.nvim
a neovim comment and annotation plugin using coroutine
Stars: ✭ 47 (-22.95%)
Mutual labels:  annotation
piaf
Question Answering annotation platform - Plateforme d'annotation
Stars: ✭ 62 (+1.64%)
Mutual labels:  annotation
ansible-role-fail2ban
Install and configure fail2ban on your system.
Stars: ✭ 42 (-31.15%)
Mutual labels:  playbook
ofxOpenCvDnnObjectDetection
OpenCV based DNN Object Detection Library for Openframeworks
Stars: ✭ 34 (-44.26%)
Mutual labels:  annotation
doccano-transformer
The official tool for transforming doccano format into common dataset formats.
Stars: ✭ 87 (+42.62%)
Mutual labels:  annotation
mysql secure installation Ansible
Idempotent Ansible Module that provides the functions of "mysql_secure_installation" script
Stars: ✭ 34 (-44.26%)
Mutual labels:  playbook
macos-playbook
Ansible playbook for OS X. Installs the common apps and libraries for web developers
Stars: ✭ 34 (-44.26%)
Mutual labels:  playbook
bane
Chainlink security and orchestration tools for Ubuntu server
Stars: ✭ 6 (-90.16%)
Mutual labels:  playbook
mastible
An Ansible playbook to install Mastodon
Stars: ✭ 17 (-72.13%)
Mutual labels:  playbook
frontend-toolkit
Tools, documentation and resources for creating front-end pages and apps in Hypothesis
Stars: ✭ 18 (-70.49%)
Mutual labels:  annotation
ansible-war-deploy
A playbook to deploy a WAR on Tomcat & restart it.
Stars: ✭ 20 (-67.21%)
Mutual labels:  playbook
elk-upgrade
Elastic Stack Upgrade with Ansible
Stars: ✭ 28 (-54.1%)
Mutual labels:  playbook
ansible-role-etcd
Ansible role for installing etcd cluster
Stars: ✭ 38 (-37.7%)
Mutual labels:  playbook
fit
easy storage Object on SharedPreferences
Stars: ✭ 53 (-13.11%)
Mutual labels:  annotation
BACTpipe
BACTpipe: An assembly and annotation pipeline for bacterial genomics
Stars: ✭ 19 (-68.85%)
Mutual labels:  annotation

ansible-docgen

Description

ansible-docgen generates documentation from annotated Ansible Playbooks and Roles.

Build Status PIP Version Coverage Status Gitter IM

Installation

pip install ansible-docgen

or

easy_install ansible-docgen

Usage

Annotate Your Playbooks and Roles

---
# test_playbook.yml
# Author: John Doe
# Description: Install a Webserver
- name: Install Apache
  yum: name=httpd state=installed
---
# roles/appserver/tasks/main.yml
# Author: John Doe
# Description: Appserver role
- name: Copy Installer
  copy: src=installer dest=/tmp/
  tags:
    - copy-installer
- name:  Run Installer
  shell: /tmp/installer.sh
  tags:
    - run-installer

Generate Documentation from Annotation

Use -p to specify your project directory. Click the links to preview the Markup generated by ansible-docgen. Warning: This will overwrite existing README files.

ansible-docgen -p your_ansible_project

Generated Markup File your_ansible_project/rolestest/README.md

Generated Markup File your_ansible_project/roles/README.md

Generated Markup File your_ansible_project/README.md

If your current directory is your project directory just run ansible-docgen without any arguments. Warning: This will overwrite existing README files.

cd your_ansible_project && ansible-docgen

Generated Markup File otherroles/README.md

Generated Markup File roles/README.md

Generated Markup File README.md

License

ansible-docgen is released under the MIT License.

Author

David Whiteside ([email protected])

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].