[check_latest_packages_version] Add role documentation in sphinx

This patch adds the documentation directly in the sphinx role
documentation index. All variables have been commented with a proper
description to be included automatically in the sphinx build.

Change-Id: Ia24af3f62fcb4de2bbe2004117afe3a6ede40762
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
Gael Chamoulaud (Strider) 2021-06-23 14:33:12 +02:00
parent 5823307e67
commit 0607efaade
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
2 changed files with 46 additions and 0 deletions
doc/source/roles
validations_common/roles/check_latest_packages_version/defaults

@ -2,5 +2,49 @@
check_latest_packages_version
=============================
--------------
About The Role
--------------
An Ansible role to check if latest version of a list of packages is installed.
Requirements
============
No requirements.
Dependencies
============
No dependencies.
Example Playbook
================
.. code-block:: yaml
- hosts: localhost
gather_facts: false
vars:
packages_list:
- coreutils
- wget
roles:
- check_latest_packages_version
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:DF Squad:VF**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: validations_common/roles/check_latest_packages_version

@ -1,2 +1,4 @@
---
# List of packages to check.
# Empty list by default
packages_list: []