ansible/docs/templates/playbooks_keywords.rst.j2
Adrian Likins 66a244facc change generated playbooks_keywords.rst to use an rst 'glossary' (#28843)
* Use a rst glossary for playbooks_keywords docs
* Add a 'Task' and 'Tasks' to glossary.
* Update keywords desciptions,
* use :term: rst ref, some quoting
* Make it more obvious that 'retries' and 'until' need to be used in combination.

(cherry picked from commit 52f2edf19d)
2017-09-08 12:15:22 -07:00

26 lines
748 B
Django/Jinja

Directives Glossary
===================
Here we list the common playbook objects and their directives.
Note that not all directives affect the object itself and might just be there to be inherited by other contained objects.
Aliases for the directives are not reflected here, nor are mutable ones, for example `action` in task can be substituted by the name of any module plugin.
Be aware that this reflects the 'current development branch' and that the keywords do not have 'version_added' information.
.. contents::
:local:
:depth: 1
{% for name in clist %}
{{ name }}
{{ '-' * name|length }}
.. glossary::
{% for attribute in oblist[name]|sort %}
{{ attribute }}
{{ oblist[name][attribute] }}
{% endfor %}
{% endfor %}