diff options
| author | Joseph Herlant <aerostitch@users.noreply.github.com> | 2018-03-26 16:28:28 -0700 |
|---|---|---|
| committer | scottb <dharmabumstead@users.noreply.github.com> | 2018-03-26 16:28:28 -0700 |
| commit | 00a7ff7974bf39314170e1d84c18f95d059eaa3c (patch) | |
| tree | 4e2740d1a9a5109514ece67fa41918c9c667f608 /docs/templates | |
| parent | 02f44176b940b8432ff31fc49a4632ed3315522e (diff) | |
| download | ansible-00a7ff7974bf39314170e1d84c18f95d059eaa3c.tar.gz | |
Move man pages generations to rst2man (#37861)
Diffstat (limited to 'docs/templates')
| -rw-r--r-- | docs/templates/man.j2 | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/templates/man.j2 b/docs/templates/man.j2 index c9a06994e8..9ded1ec68f 100644 --- a/docs/templates/man.j2 +++ b/docs/templates/man.j2 @@ -1,16 +1,15 @@ {% set name = ('ansible' if cli == 'adhoc' else 'ansible-%s' % cli) -%} -{{name}}(1) -{{ '=' * ((name|length|int) + 3) }} -:doctype: manpage -:encoding: utf-8 -:lang: en -:man source: Ansible -:man version: %VERSION% -:man manual: System administration commands +{{name}} +{{ '=' * ( name|length|int ) }} + +{{ '-' * ( short_desc|default('')|string|length|int ) }} +{{short_desc|default('')}} +{{ '-' * ( short_desc|default('')|string|length|int ) }} + +:Version: Ansible %VERSION% +:Manual section: 1 +:Manual group: System administration commands -NAME ----- -ansible{% if cli != 'adhoc' %}-{{cli}}{% endif %} - {{short_desc|default('')}} SYNOPSIS @@ -26,9 +25,9 @@ DESCRIPTION COMMON OPTIONS -------------- {% for option in options|sort(attribute='options') %} -{% for switch in option['options'] %}*{{switch}}*{% if option['arg'] %} '{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}:: +{% for switch in option['options'] %}**{{switch}}**{% if option['arg'] %} '{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %} -{{ option['desc'] }} + {{ option['desc'] }} {% endfor %} {% endif %} @@ -48,11 +47,12 @@ ARGUMENTS ACTIONS ------- {% for action in actions %} - *{{ action }}*::: {{ (actions[action]['desc']|default(' '))|wordwrap}} +**{{ action }}** + {{ (actions[action]['desc']|default(' '))}} {% if actions[action]['options'] %} {% for option in actions[action]['options']|sort(attribute='options') %} -{% for switch in option['options'] if switch in actions[action]['option_names'] %}*{{switch}}*{% if option['arg'] %} '{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %}:: +{% for switch in option['options'] if switch in actions[action]['option_names'] %}**{{switch}}**{% if option['arg'] %} '{{option['arg']}}'{% endif %}{% if not loop.last %}, {% endif %}{% endfor %} {{ (option['desc']) }} {% endfor %} @@ -116,7 +116,7 @@ Ansible is released under the terms of the GPLv3 License. SEE ALSO -------- -{% for other in cli_list|sort %}{% if other != cli %}*ansible{% if other != 'adhoc' %}-{{other}}{% endif %}*(1){% if not loop.last %}, {% endif %}{% endif %}{% endfor %} +{% for other in cli_list|sort %}{% if other != cli %}**ansible{% if other != 'adhoc' %}-{{other}}{% endif %}** (1){% if not loop.last %}, {% endif %}{% endif %}{% endfor %} Extensive documentation is available in the documentation site: <http://docs.ansible.com>. |