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

module_formatter now also uses Jinja2 trim_blocks

- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
This commit is contained in:
Jan-Piet Mens 2012-09-30 15:06:18 +02:00
parent f13e20655e
commit e4338d0ca3
3 changed files with 22 additions and 19 deletions

View file

@ -221,6 +221,7 @@ def main():
env = Environment(loader=FileSystemLoader(args.template_dir),
variable_start_string="@{",
variable_end_string="}@",
trim_blocks=True,
)
env.globals['xline'] = rst_xline

View file

@ -4,56 +4,58 @@
@{ module }@ \- @{ short_description }@
." ------ DESCRIPTION
.SH DESCRIPTION
{% for desc in description -%}
{% for desc in description %}
.PP
@{ desc | jpfunc }@
{% endfor %}
." ------ OPTIONS
."
."
{% if options -%}
{% if options %}
.SH OPTIONS
{% for (k,v) in options.iteritems() %}
.IP @{ k }@
{% for desc in v.description -%}@{ desc | jpfunc }@{% endfor -%}
{% for desc in v.description %}@{ desc | jpfunc }@{% endfor %}
{% if v.get('choices') %}
.IR Choices :
{% for choice in v.get('choices',[]) -%}@{ choice }@{% if not loop.last %},{%else%}.{%endif-%}{% endfor -%}{% endif %}
{% if v.get('required') %}(required){% endif -%}
{% if v.get('default') %} (default: @{ v.get('default') }@){% endif -%}
{% for choice in v.get('choices',[]) %}@{ choice }@{% if not loop.last %},{%else%}.{%endif%}{% endfor %}{% endif %}
{% if v.get('required') %}(required){% endif %}
{% if v.get('default') %} (default: @{ v.get('default') }@){% endif %}
{#---------------------------------------------- #}
{% if v.get('version_added') -%}
{% if v.get('version_added') %}
(Added in Ansible version @{ v.get('version_added') }@.)
{% endif -%}
{% endif %}
{% endfor %}
{% endif %}
."
."
." ------ NOTES
{% if notes -%}
{% if notes %}
.SH NOTES
{% for note in notes -%}
{% for note in notes %}
.PP
@{ note | jpfunc }@
{% endfor -%}
{% endif -%}
{% endfor %}
{% endif %}
."
."
." ------ EXAMPLES
{% if examples is defined -%}
{% if examples is defined %}
.SH EXAMPLES
{% for e in examples -%}
{% for e in examples %}
.PP
.nf
@{ e['code'] }@
.fi
{% endfor -%}
{% endif -%}
{% endfor %}
{% endif %}
." ------- AUTHOR
{% if author is defined -%}
{% if author is defined %}
.SH AUTHOR
@{ author }@
{% endif -%}
{% endif %}
.SH SEE ALSO
.IR ansible (1),
.I http://ansible.github.com/modules.html#@{docuri}@

View file

@ -23,7 +23,7 @@
DOCUMENTATION = '''
---
module: facter
short_description: Runs the discovery program facter on the remote system
short_description: Runs the discovery program I(facter) on the remote system
description:
- Runs the discovery program I(facter) on the remote system, returning JSON
data that can be useful for inventory purposes.