cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

module docs: fixed rst template

Browse source 
- notes is now supported
- multiline code examples are now supported (HTML rendering was off)
This commit is contained in:
Jan-Piet Mens 2012-09-30 13:20:24 +02:00
parent 13e8ef5f35
commit 80a9016636
1 changed files with 12 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
hacking/templates/rst.j2
View file

@ -18,7 +18,7 @@
@{ desc | jpfunc }@ @{ desc | jpfunc }@
{% endfor %} {% endfor %}
{% if options is defined -%} {% if options -%}
.. raw:: html .. raw:: html
<table> <table>
@ -33,7 +33,7 @@
<tr> <tr>
<td>@{ k }@</td> <td>@{ k }@</td>
<td>@{ v.get('required',False) }@</td> <td>@{ v.get('required',False) }@</td>
<td>@{ v['default'] }@</td> <td>{% if v['default'] %}@{ v['default'] }@{% endif %}</td>
<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>
<td>{% for desc in v.description -%}@{ desc | html_ify }@{% endfor -%}</td> <td>{% for desc in v.description -%}@{ desc | html_ify }@{% endfor -%}</td>
</tr> </tr>
@ -46,8 +46,17 @@
{% for example in examples %} {% for example in examples %}
{% if example['description'] %}<p>@{ example['description'] | html_ify }@</p>{% endif %} {% if example['description'] %}<p>@{ example['description'] | html_ify }@</p>{% endif %}
<p><pre> <p><pre>
@{ example['code'] }@</pre></p> @{ example['code'] }@
</pre></p>
{% endfor %} {% endfor %}
<br/> <br/>
{% if notes %}
.. raw:: html
<h4>Notes</h4>
{% for note in notes %}
<p>@{ note | html_ify }@</p>
{% endfor %}
{% endif %}