[no_op] 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.

This patch also disables the facts gathering because this validation
doesn't need them.

Change-Id: I99a506d17a2e76c9513745db877e5ce0ba3aae6a
Signed-off-by: Gael Chamoulaud (Strider) <gchamoul@redhat.com>
This commit is contained in:
Gael Chamoulaud (Strider) 2021-06-24 07:06:19 +02:00
parent b75dc0a062
commit e5be8fb969
No known key found for this signature in database
GPG Key ID: 4119D0305C651D66
2 changed files with 41 additions and 0 deletions
doc/source/roles
validations_common/playbooks

@ -2,5 +2,45 @@
no_op
=====
--------------
About The Role
--------------
A no-op Ansible role for testing that the validations framework runs.
Requirements
============
No requirements.
Dependencies
============
No dependencies.
Example Playbook
================
.. code-block:: yaml
- hosts: localhost
gather_facts: false
roles:
- no_op
License
=======
Apache
Author Information
==================
**Red Hat TripleO DFG:DF Squad:VF**
----------------
Full Description
----------------
.. ansibleautoplugin::
:role: validations_common/roles/no_op

@ -1,5 +1,6 @@
---
- hosts: localhost
gather_facts: false
vars:
metadata:
name: NO-OP validation