Docsible is a command-line interface (CLI) written in Python that automates the documentation of Ansible roles and collections. It generates a Markdown-formatted README file for role or collection by scanning the Ansible YAML files.
- Generates a README in Markdown format
- Scans and includes default variables and role-specific variables
- Parses tasks, including special Ansible task types like 'block' and 'rescue'
- Optionally includes playbook content in the README
- CLI-based, easy to integrate into a CI/CD pipeline
- Provides a templating feature to customize output
- Supports multiple YAML files within
tasks,defaults,varsdirectory - Includes meta-data like author and license from
meta/main.[yml/yaml] - Generates a well-structured table for default and role-specific variables
- Support for encrypted Ansible Vault variables
To install Docsible, you can run:
pip install docsibleTo use Docsible, you can run the following command in your terminal:
docsible --role /path/to/ansible/role --playbook /path/to/playbook.yml --graphdocsible --collection ./collections_tests/lucian/ --no-backup --graphdocsible --role /path/to/ansible/role # without include a playbook into readme$ docsible --help
Usage: docsible [OPTIONS]
Options:
--role TEXT Path to the Ansible role directory.
--collection TEXT Path to the Ansible collection directory.
--playbook TEXT Path to the playbook file.
--graph Generate Mermaid graph for tasks.
--no-backup Do not backup the readme before remove.
--no-docsible Do not create .docsible file and do not print relative variable to generated README.md.
--comments Read comments from tasks files.
--md-template Path to the markdown template file.
--append Append to the existing README.md instead of replacing it.
--version Show the module version.
--help Show this message and exit.--role: Specifies the directory path to the Ansible role.--collection: Specifies the directory path to the Ansible collection.--playbook: Specifies the path to the Ansible playbook (Optional). ( Works only with roles )--graph: Generate mermaid for role and playbook.--no-backup: Ignore existent README.md and remove before generate a new one. (Optional).--comments: Read comments from tasks files. (Optional).--md-template: Specifies the path to the markdown template file (Optional). ( Works only with roles )--append: Append existing readme.md if needed
Docsible fetches information from the following files within the specified Ansible role:
defaults/*.yml/yaml: For default variablesvars/*.yml/yaml: For role-specific variablesmeta/main.yml/yaml: For role metadatatasks/*.yml/yaml: For tasks, including special task types and subfolders
Demo2 coffeemaker_morning role
Docsible works with Python 3.x and requires the following libraries:
- Click
- Jinja2
- PyYAML
- Clean the code
- Add more features
- Custom templates for collection
- Multiple playbooks handle into mermaid for collection and role
This tool work whith several type of comments.
The tool read comments placed before a variable, only if it begin with specific tag:
# title: This tag will be used for popiulate the column Title of the README.md. It is a short description of the variable
# required: This tag will be used for popiulate the column Required of the README.md
The tool will read all the line before each - name: of the tasks that begin with #.
All comment will be reported to the column Comments of the tasks tables.
For details on how to contribute, please read the Contributing Guidelines.
This project is licensed under the MIT License. See the LICENSE file for more details.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent