1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00

provide sections and local TOC for module documentation

This commit is contained in:
Mikhail Sobolev 2013-12-25 21:05:43 +02:00
parent 7965d331f3
commit 1713013dba

View file

@ -2,6 +2,13 @@
@{ module }@ @{ module }@
++++++++++++++++++++++++++++++++++++++ ++++++++++++++++++++++++++++++++++++++
{% if author %}
:Author: @{ author }@
{% endif %}
.. contents::
:local:
:depth: 1
{# ------------------------------------------ {# ------------------------------------------
# #
@ -10,6 +17,9 @@
# #
--------------------------------------------#} --------------------------------------------#}
Synopsis
--------
{% if version_added is defined -%} {% if version_added is defined -%}
.. versionadded:: @{ version_added }@ .. versionadded:: @{ version_added }@
{% endif %} {% endif %}
@ -19,6 +29,9 @@
{% endfor %} {% endfor %}
{% if options -%} {% if options -%}
Options
-------
.. raw:: html .. raw:: html
<table border=1 cellpadding=4> <table border=1 cellpadding=4>
@ -54,7 +67,10 @@
{% endfor %} {% endfor %}
{% endif %} {% endif %}
{% if not plainexamples %} {% if examples or plainexamples %}
Examples
--------
.. raw:: html .. raw:: html
{% for example in examples %} {% for example in examples %}
@ -66,19 +82,18 @@
</p> </p>
{% endfor %} {% endfor %}
<br/> <br/>
{% endif %}
{% if plainexamples %} {% if plainexamples %}
Examples:: ::
@{ plainexamples | escape | indent(4, True) }@ @{ plainexamples | escape | indent(4, True) }@
{% endif %} {% endif %}
{% endif %}
{% if notes %} {% if notes %}
{% for note in notes %} {% for note in notes %}
.. note:: @{ note | html_ify }@</p> .. note:: @{ note | convert_symbols_to_format }@
{% endfor %} {% endfor %}
{% endif %} {% endif %}