Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

autodoc for ansible playbook

Project Description

sphinxcontrib-ansibleautodoc is an sphinx extension which can search task in ansible playbook and generate document.

install

pip install sphinxcontrib-ansibleautodoc

and add ‘sphinxcontrib.ansibleautodoc’ in extensions in your conf.py.

extensions = [
    'sphinxcontrib.ansibleautodoc',
]

How to use

Currently there is one directive called ansibleautotask.

ansibleautotask

.. ansibleautotask:: second task
   :playbook: ../ansible/web.yml

The contents of this directive is an ansible task name. If task does not have a name, directive can not find.

playbook option is for specify initial ansible playbook. ansibleautodoc scan the playbook and read include and roles as followes. So you need only one playbook file.

Output Example

License

2-clause BSD License

Release History

Release History

This version
History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_ansibleautodoc-0.0.4.tar.gz (4.7 kB) Copy SHA256 Checksum SHA256 Source Dec 21, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting