https://github.com/outbit/ansible-docgen

Generate documentation from annotated Ansible Playbooks and Roles
https://github.com/outbit/ansible-docgen

annotated-ansible-playbooks annotation ansible documentation playbook

Last synced: 3 months ago
JSON representation

Generate documentation from annotated Ansible Playbooks and Roles

• Host: GitHub
• URL: https://github.com/outbit/ansible-docgen
• Owner: outbit
• License: mit
• Created: 2015-07-29T04:19:31.000Z (almost 9 years ago)
• Default Branch: develop
• Last Pushed: 2023-10-07T00:20:50.000Z (9 months ago)
• Last Synced: 2024-03-07T10:47:38.557Z (4 months ago)
• Topics: annotated-ansible-playbooks, annotation, ansible, documentation, playbook
• Language: Python
• Homepage:
• Size: 151 KB
• Stars: 65
• Watchers: 7
• Forks: 13
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Lists

• my-awesome-stars - outbit/ansible-docgen - Generate documentation from annotated Ansible Playbooks and Roles (Python)

README

        
ansible-docgen

=====================

Description

===========

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

[![Build Status](https://app.travis-ci.com/thedavidwhiteside/ansible-docgen.svg?branch=develop "ansible-docs latest build")](http://travis-ci.org/thedavidwhiteside/ansible-docgen)

[![PIP Version](https://img.shields.io/pypi/v/ansible-docgen.svg "ansible-docs PyPI version")](https://pypi.python.org/pypi/ansible-docgen)

[![Coverage Status](https://coveralls.io/repos/thedavidwhiteside/ansible-docgen/badge.svg?branch=develop&service=github)](https://coveralls.io/github/thedavidwhiteside/ansible-docgen?branch=develop)

[![Gitter IM](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/thedavidwhiteside/ansible-docgen)

Installation

===========

```shell

pip install ansible-docgen

```

or

```shell

easy_install ansible-docgen

```

Usage

===========

### Annotate Your Playbooks and Roles

```yaml

---

# test_playbook.yml

# Author: John Doe

# Description: Install a Webserver

- name: Install Apache

  yum: name=httpd state=installed

```

```yaml

---

# 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](test/integration/project1/rolestest/README.md)

`Generated Markup File` [your_ansible_project/roles/README.md](test/integration/project1/roles/README.md)

`Generated Markup File` [your_ansible_project/README.md](test/integration/project1/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](test/integration/project1/otherroles/README.md)

`Generated Markup File` [roles/README.md](test/integration/project1/roles/README.md)

`Generated Markup File` [README.md](test/integration/project1/README.md)

License

=======

ansible-docgen is released under the [MIT License](LICENSE.md).

Author

======

David Whiteside ()