sphinxcontrib-ansibleautodoc is an sphinx extension which can search task in ansible playbook and generate document.
pip install sphinxcontrib-ansibleautodoc
and add ‘sphinxcontrib.ansibleautodoc’ in extensions in your conf.py.
extensions = [
'sphinxcontrib.ansibleautodoc',
]
Currently there is one directive called 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.
2-clause BSD License
TODO: Figure out how to actually get changelog content.
Changelog content for this version goes here.
Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
TODO: Figure out how to actually get changelog content.
Changelog content for this version goes here.
Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
TODO: Figure out how to actually get changelog content.
Changelog content for this version goes here.
Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
TODO: Figure out how to actually get changelog content.
Changelog content for this version goes here.
Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.
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 |
