Auto-generate ansible role documentation
Project description
ansible-document
Automatically document ansible roles.
Concept
Generate documentation automatically by looking up a role's content.
Usage
$ ansible-mkdocs path/to/role
# ex:
$ ansible-mkdocs examples/install_gitlab
name | value | location
------|------|------
gitlab_package_script_url | https://packages.gitlab.com/install/repositories/gitlab/gitlab-ce/script.deb.sh | vars/main.yml
gitlab_interface | {{ ansible_default_ipv4['interface'] }} | defaults/main.yml
gitlab_addr | {{ hostvars[inventory_hostname]['ansible_' + gitlab_interface]['ipv4']['address'] }} | defaults/main.yml
gitlab_install | yes | defaults/main.yml
How does it work?
- Generate a list with modules and their values
- Example: copy will be used, register the mode, required, ...
- Lookup every directory (files, tasks, vars, ...) and fetch information
- For every directory, generate the associated template
- Aggregate every generated templates
- Add metadata
- Has tests
- Has molecule
- Meta from meta/
- Output markdown
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
ansible_mkdocs-0.0.2.tar.gz
(4.1 kB
view hashes)
Built Distribution
Close
Hashes for ansible_mkdocs-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 37411016c69a03ed2ffead9403cc0f975d73b1c607044fc954c091e199c23b65 |
|
MD5 | 7da8a37bfc3e62a40addd0529a81fa7c |
|
BLAKE2b-256 | cd8ebff9c907ce057463f984e945ba0cb24daddd66783d311f5e1598032f3004 |