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

provide sections and local TOC for module documentation

Browse source
This commit is contained in:
Mikhail Sobolev 2013-12-25 21:05:43 +02:00
parent 7965d331f3
commit 1713013dba
1 changed files with 20 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
hacking/templates/rst.j2
View file

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