sphinx-ansible-ext 0.1.3

Sphinx documentation Ansible directives and yaml2rst

Sphinx Ansible extension

Sphinx documentation Ansible directives and yaml2rst

Installation

You can install the latest version from PyPI package repository.

python3 -mpip install -U sphinx-ansible-ext

Usage

• conversions.yaml2rst_role_defaults(search_path, dst_path, filename="main.yml", *, force=False)

Searches through search_path for defaults/<filename.yml and converts the yaml file to rst.

• directive ansible-var-desc

Builds a table to describe the variables. Input format is:

variable
  type [/ required]
  Help string

Example:

username
  string / required
  The username.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Locations

• Documentation: https://gitlab.com/twiddle-z/sphinx-ansible-ext
• Website: https://gitlab.com/twiddle-z/sphinx-ansible-ext
• PyPi: https://pypi.org/project/sphinx-ansible-ext