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.2.tar.gz
(16.2 kB
view hashes)
Built Distribution
Close
Hashes for sphinx_ansible-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddda1b0bbac328a0489064b6ed352f9496004a0b039bfc2f312d606c6b0b550e |
|
MD5 | 8aab44010da9eee00cd6706b314e51aa |
|
BLAKE2b-256 | 050c80654d1a278ff5d0651b22abf71be1dabe40fc6a3a181adaaa85866a2c88 |