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
Built Distribution
File details
Details for the file sphinx-ansible-0.0.2.tar.gz
.
File metadata
- Download URL: sphinx-ansible-0.0.2.tar.gz
- Upload date:
- Size: 16.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d3d8869f9bdd4c323763ab3743195aa7c3cfe7370bc443f1d9ec30d01bee6532 |
|
MD5 | 99e9de8eacca5ffa98b03259dec647c9 |
|
BLAKE2b-256 | ffe526668f1bface18f5e71f0001a8a6760879ef6b23cb0b2d9cafb91af51f02 |
File details
Details for the file sphinx_ansible-0.0.2-py3-none-any.whl
.
File metadata
- Download URL: sphinx_ansible-0.0.2-py3-none-any.whl
- Upload date:
- Size: 16.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ddda1b0bbac328a0489064b6ed352f9496004a0b039bfc2f312d606c6b0b550e |
|
MD5 | 8aab44010da9eee00cd6706b314e51aa |
|
BLAKE2b-256 | 050c80654d1a278ff5d0651b22abf71be1dabe40fc6a3a181adaaa85866a2c88 |