internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-06 21:32:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

Keywords docs (#32807)

Browse Source 
* Fixup keyword dumping

* Clarify introductory text
* Turn links in the keyword description into seealso entries in the rst.

* Have plugin_formatter cleanup trailing whitespace

The indent filter in jinja2 < 2.10 indents blank lines by default which
leads to trailing whitespace.  Cleanup after that filter.

* Edits

* Copy edit
This commit is contained in:
Toshio Kuratomi
2017-11-10 16:59:26 -08:00
committed by scottb
parent 54648ac3e9
commit e07cbb033f
5 changed files with 67 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/templates/playbooks_keywords.rst.j2 vendored
View File

@@ -1,11 +1,16 @@
Directives Glossary
===================
Playbook Keywords
=================
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.
These are the keywords available on common playbook objects.
.. note:: Please note:
* Aliases for the directives are not reflected here, nor are mutable one. For example,
:term:`action` in task can be substituted by the name of any Ansible module.
* The keywords do not have ``version_added`` information at this time
* Some keywords set defaults for the objects inside of them rather than for the objects
themselves
Be aware that this reflects the 'current development branch' and that the keywords do not have 'version_added' information.
.. contents::
:local:
@@ -19,8 +24,7 @@ Be aware that this reflects the 'current development branch' and that the keywor
{% for attribute in oblist[name]|sort %}
{{ attribute }}
{{ oblist[name][attribute] }}
{{ oblist[name][attribute] |indent(8) }}
{% endfor %}
{% endfor %}