mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
7681b1ce68
- The html_ify filter now escapes HTML found in module documentation.
THIS COULD AFFECT MORE THAN JUST MARKDOWN but I didn't see any modules
expecting to use e.g. HTML entities or HTML tags in their
documentation.
- The markdown_ify filter (used as jpfunc in markdown.j2) escapes at
least a few Markdown in-line formatting characters.
- Improvements to markdown.j2:
- Call jpfunc on the module name heading so that it gets escaped for
Markdown (e.g. my_module_name becomes my\_module\_name).
- Added paragraph breaks between paragraphs in the description.
- Added examples heading, which is consistent with the notes heading
below it.
64 lines
1.3 KiB
Django/Jinja
64 lines
1.3 KiB
Django/Jinja
## @{ module | jpfunc }@
|
|
|
|
{# ------------------------------------------
|
|
#
|
|
# This is Github-flavored Markdown
|
|
#
|
|
--------------------------------------------#}
|
|
|
|
{% if version_added is defined -%}
|
|
New in version @{ version_added }@.
|
|
{% endif %}
|
|
|
|
{% for desc in description -%}
|
|
@{ desc | jpfunc }@
|
|
|
|
{% endfor %}
|
|
|
|
{% if options -%}
|
|
<table>
|
|
<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,v) in options.iteritems() %}
|
|
<tr>
|
|
<td>@{ k }@</td>
|
|
<td>{% if v.get('required', False) %}yes{% else %}no{% endif %}</td>
|
|
<td>{% if v['default'] %}@{ v['default'] }@{% endif %}</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 -%}{% if v['version_added'] %} (added in Ansible @{v['version_added']}@){% endif %}</td>
|
|
</tr>
|
|
{% endfor %}
|
|
</table>
|
|
{% endif %}
|
|
|
|
{% if examples or plainexamples %}
|
|
#### Examples
|
|
{% endif %}
|
|
|
|
{% for example in examples %}
|
|
{% if example['description'] %}
|
|
* @{ example['description'] | jpfunc }@
|
|
{% endif %}
|
|
|
|
```
|
|
@{ example['code'] }@
|
|
```
|
|
{% endfor %}
|
|
{% if plainexamples -%}
|
|
```
|
|
@{ plainexamples }@
|
|
```
|
|
{% endif %}
|
|
|
|
{% if notes %}
|
|
#### Notes
|
|
{% for note in notes %}
|
|
@{ note | jpfunc }@
|
|
{% endfor %}
|
|
{% endif %}
|
|
|