.. _@{ module }@: @{ module }@ `````````````````````````````` {# ------------------------------------------ # # Please note: this looks like a core dump # but it isn't one. # --------------------------------------------#} {% if version_added is defined -%} .. versionadded:: @{ version_added }@ {% endif %} {% for desc in description -%} @{ desc | jpfunc }@ {% endfor %} {% if options -%} .. raw:: html {% for k in option_keys %} {% set v = options[k] %} {% endfor %}
parameter required default choices comments
@{ k }@ {% if v.get('required', False) %}yes{% else %}no{% endif %} {% if v['default'] %}@{ v['default'] }@{% endif %}
    {% for choice in v.get('choices',[]) -%}
  • @{ choice }@
  • {% endfor -%}
{% for desc in v.description -%}@{ desc | html_ify }@{% endfor -%}{% if v['version_added'] %} (added in Ansible @{v['version_added']}@){% endif %}
{% endif %} .. raw:: html {% for example in examples %} {% if example['description'] %}

@{ example['description'] | html_ify }@

{% endif %}

@{ example['code'] | escape | indent(4, True) }@
    

{% endfor %}
{% if notes %} .. raw:: html

Notes

{% for note in notes %}

@{ note | html_ify }@

{% endfor %} {% endif %}