mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
minor docs reformat
- clearer 'version added' for module options, now it sits under the option name - made notes a section, so it now appears in toc - moved requirements and made it a list, more prominent and more readable
This commit is contained in:
parent
337b1dc45c
commit
0826106441
1 changed files with 20 additions and 11 deletions
|
@ -43,6 +43,17 @@ Synopsis
|
||||||
@{ desc | convert_symbols_to_format }@
|
@{ desc | convert_symbols_to_format }@
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
|
|
||||||
|
{% if requirements %}
|
||||||
|
Requirements
|
||||||
|
------------
|
||||||
|
|
||||||
|
{% for req in requirements %}
|
||||||
|
* @{ req | convert_symbols_to_format }@
|
||||||
|
{% endfor %}
|
||||||
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
{% if options -%}
|
{% if options -%}
|
||||||
Options
|
Options
|
||||||
-------
|
-------
|
||||||
|
@ -60,7 +71,7 @@ Options
|
||||||
{% for k in option_keys %}
|
{% for k in option_keys %}
|
||||||
{% set v = options[k] %}
|
{% set v = options[k] %}
|
||||||
<tr>
|
<tr>
|
||||||
<td>@{ k }@</td>
|
<td>@{ k }@<br/><div style="font-size: small;">{% if v['version_added'] %} (added in @{v['version_added']}@){% endif %}</div></td>
|
||||||
<td>{% if v.get('required', False) %}yes{% else %}no{% endif %}</td>
|
<td>{% if v.get('required', False) %}yes{% else %}no{% endif %}</td>
|
||||||
<td>{% if v['default'] %}@{ v['default'] }@{% endif %}</td>
|
<td>{% if v['default'] %}@{ v['default'] }@{% endif %}</td>
|
||||||
{% if v.get('type', 'not_bool') == 'bool' %}
|
{% if v.get('type', 'not_bool') == 'bool' %}
|
||||||
|
@ -68,21 +79,16 @@ Options
|
||||||
{% else %}
|
{% else %}
|
||||||
<td><ul>{% for choice in v.get('choices',[]) -%}<li>@{ choice }@</li>{% endfor -%}</ul></td>
|
<td><ul>{% for choice in v.get('choices',[]) -%}<li>@{ choice }@</li>{% endfor -%}</ul></td>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
<td>{% for desc in v.description -%}@{ desc | html_ify }@{% endfor -%}{% if v['version_added'] %} (added in Ansible @{v['version_added']}@){% endif %}</td>
|
<td>{% for desc in v.description -%}@{ desc | html_ify }@{% endfor -%}</td>
|
||||||
</tr>
|
</tr>
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if requirements %}
|
|
||||||
{% for req in requirements %}
|
|
||||||
|
|
||||||
.. note:: Requires @{ req | convert_symbols_to_format }@
|
|
||||||
|
|
||||||
{% endfor %}
|
{% if examples or plainexamples -%}
|
||||||
{% endif %}
|
|
||||||
|
|
||||||
{% if examples or plainexamples %}
|
|
||||||
Examples
|
Examples
|
||||||
--------
|
--------
|
||||||
|
|
||||||
|
@ -107,7 +113,7 @@ Examples
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
|
|
||||||
{% if returndocs %}
|
{% if returndocs -%}
|
||||||
Return Values
|
Return Values
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
@ -164,7 +170,10 @@ Common return values are documented here :doc:`common_return_values`, the follow
|
||||||
</br></br>
|
</br></br>
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% if notes %}
|
{% if notes -%}
|
||||||
|
Notes
|
||||||
|
-----
|
||||||
|
|
||||||
{% for note in notes %}
|
{% for note in notes %}
|
||||||
.. note:: @{ note | convert_symbols_to_format }@
|
.. note:: @{ note | convert_symbols_to_format }@
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
Loading…
Reference in a new issue