/hacking/templates/rst.j2
https://github.com/ajanthanm/ansible · Jinja · 107 lines · 79 code · 22 blank · 6 comment · 21 complexity · 6d2ac7dcbfa7ca633c63daf83a855b0e MD5 · raw file
- .. _@{ 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 }@
- {% if author %}
- :Author: @{ author }@
- {% endif %}
- .. 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
- <table border=1 cellpadding=4>
- <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>
- {% if v.get('type', 'not_bool') == 'bool' %}
- <td><ul><li>yes</li><li>no</li></ul></td>
- {% else %}
- <td><ul>{% for choice in v.get('choices',[]) -%}<li>@{ choice }@</li>{% endfor -%}</ul></td>
- {% endif %}
- <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 %}
- {% 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'] %}<p>@{ example['description'] | html_ify }@</p>{% endif %}
- <p>
- <pre>
- @{ example['code'] | escape | indent(4, True) }@
- </pre>
- </p>
- {% endfor %}
- <br/>
- {% if plainexamples %}
- ::
- @{ plainexamples | indent(4, True) }@
- {% endif %}
- {% endif %}
- {% if notes %}
- {% for note in notes %}
- .. note:: @{ note | convert_symbols_to_format }@
- {% endfor %}
- {% endif %}