Skip to main content

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

images/screenshot-1.png

License

2-clause BSD License

Project details


Download files

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

Source Distribution

sphinxcontrib_ansibleautodoc-0.0.5.tar.gz (5.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page