Imagine a world where your documentation is also your Ansible playbook
Project description
sphinx-ansible
sphinx-ansible
is an extension that allow you to include real Ansible tasks in your documentation and run them like if it was a regular playbook. The result is recorded in the final document.
sphinx-ansible
will also fit well in a CI/CD workflow and become a wait to ensure the documentation works as expected. It also avoid the tedious maintenance of the task output examples in a documentation. Finally, it's also a way to convert your existing functional tests in manual for your users.
Documentation: https://sphinx-ansible.readthedocs.io/en/latest/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
sphinx-ansible-0.0.1.tar.gz
(16.0 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_ansible-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58c898d2082def606fbe4678c3d71424d7339507d3f90b95352a62fb938d00e1 |
|
MD5 | 92f80f030f253ee1822b6f8eb73ad909 |
|
BLAKE2b-256 | a20affc81c37ffcfa76f4342536bf21d26bcba17094aecad8f47a308dc518e00 |