.. _@{ module }@: {% if short_description %} {% set title = module + ' - ' + short_description|convert_symbols_to_format %} {% else %} {% set title = module %} {% endif %} {% set title_len = title|length %} @{ title }@ @{ '+' * title_len }@ .. contents:: :local: :depth: 1 {# ------------------------------------------ # # Please note: this looks like a core dump # but it isn't one. # --------------------------------------------#} Synopsis -------- {% if version_added is defined -%} .. versionadded:: @{ version_added }@ {% endif %} {% for desc in description -%} @{ desc | convert_symbols_to_format }@ {% endfor %} {% if options -%} Options ------- .. raw:: html {% for k in option_keys %} {% set v = options[k] %} {% if v.get('type', 'not_bool') == 'bool' %} {% else %} {% endif %} {% endfor %}
parameter required default choices comments
@{ k }@ {% if v.get('required', False) %}yes{% else %}no{% endif %} {% if v['default'] %}@{ v['default'] }@{% endif %}
  • yes
  • no
    {% 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 %} {% if requirements %} {% for req in requirements %} .. note:: Requires @{ req | convert_symbols_to_format }@ {% endfor %} {% endif %} {% if examples or plainexamples %} Examples -------- .. raw:: html {% for example in examples %} {% if example['description'] %}

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

{% endif %}

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

{% endfor %}
{% if plainexamples %} :: @{ plainexamples | indent(4, True) }@ {% endif %} {% endif %} {% if notes %} {% for note in notes %} .. note:: @{ note | convert_symbols_to_format }@ {% endfor %} {% endif %}