.. _@{ 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 <table> <tr> <th class="head">parameter</th> <th class="head">required</th> <th class="head">default</th> <th class="head">choices</th> <th class="head">comments</th> </tr> {% for k in option_keys %} {% set v = options[k] %} <tr> <td>@{ k }@</td> <td>{% if v.get('required', False) %}yes{% else %}no{% endif %}</td> <td>{% if v['default'] %}@{ v['default'] }@{% endif %}</td> <td><ul>{% for choice in v.get('choices',[]) -%}<li>@{ choice }@</li>{% endfor -%}</ul></td> <td>{% for desc in v.description -%}@{ desc | html_ify }@{% endfor -%}{% if v['version_added'] %} (added in Ansible @{v['version_added']}@){% endif %}</td> </tr> {% endfor %} </table> {% endif %} .. raw:: html {% for example in examples %} {% if example['description'] %}<p>@{ example['description'] | html_ify }@</p>{% endif %} <p> <pre> @{ example['code'] | escape | indent(4, True) }@ </pre> </p> {% endfor %} <br/> {% if plainexamples %} .. raw:: html <pre> @{ plainexamples | escape | indent(4, True) }@ </pre> {% endif %} {% if notes %} .. raw:: html <h4>Notes</h4> {% for note in notes %} <p>@{ note | html_ify }@</p> {% endfor %} {% endif %}