6a0034ebca
This brings this documentation into line with other values like attr where you can specify the type of the variable. The type output is added to each entry where appropriate, one minor change is that we need to be less strict on the type lookup for the hint suffix on sub-entries for types like "bool" The documentation/test-case is updated. Change-Id: Icc01ec6f04af97beeb085f6dbcf37b0d9dbed1fd
46 lines
783 B
ReStructuredText
46 lines
783 B
ReStructuredText
Roles
|
|
=====
|
|
|
|
.. role:: example
|
|
|
|
This is an example role.
|
|
|
|
**Role Variables**
|
|
|
|
.. rolevar:: foo
|
|
|
|
This is a variable used by this role.
|
|
|
|
.. rolevar:: bar
|
|
:default: zero
|
|
|
|
This is a sub key.
|
|
|
|
.. rolevar:: items
|
|
:type: list
|
|
|
|
This variable is a list.
|
|
|
|
.. rolevar:: baz
|
|
|
|
This is an item in a list.
|
|
|
|
.. rolevar:: dict
|
|
:type: dict
|
|
|
|
This variable is a dict.
|
|
|
|
.. rolevar:: key
|
|
|
|
This is a key which should be assigned a value.
|
|
|
|
.. rolevar:: flag-value
|
|
:type: bool
|
|
:default: False
|
|
|
|
A variable which should be assigned a True/False value.
|
|
|
|
This is an (Ansible) role (Sphinx) role: :role:`example`
|
|
|
|
This is an (Ansible) role variable (Sphinx) role: :rolevar:`example.items.baz`
|