Giter Club home page Giter Club logo

ansible-docgen's Introduction

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/
- name:  Run Installer
  shell: /tmp/installer.sh

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])

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.