Module documentation should have options sorted

pull/1648/head
Michael DeHaan 12 years ago
parent c96f2c968e
commit 626203a7c9

@ -251,7 +251,7 @@ def main():
variable_start_string="@{",
variable_end_string="}@",
trim_blocks=True,
)
)
env.globals['xline'] = rst_xline
@ -334,6 +334,12 @@ def main():
if not doc is None:
all_keys = []
for (k,v) in doc['options'].iteritems():
all_keys.append(k)
all_keys = sorted(all_keys)
doc['option_keys'] = all_keys
doc['filename'] = fname
doc['docuri'] = doc['module'].replace('_', '-')
doc['now_date'] = datetime.date.today().strftime('%Y-%m-%d')

@ -29,7 +29,8 @@
<th class="head">choices</th>
<th class="head">comments</th>
</tr>
{% for (k,v) in options.iteritems() %}
{% for k in option_keys %}
{% set v = options[k] %}
<tr>
<td>@{ k }@</td>
<td>{% if v.get('required', False) %}yes{% else %}no{% endif %}</td>

@ -29,7 +29,7 @@ description:
(U(https://github.com/puppetlabs/facter)) on the remote system, returning
JSON data that can be useful for inventory purposes.
version_added: "0.2"
options: []
options: {}
examples:
- code: ansible www.example.net -m facter
description: "Example command-line invocation"

@ -29,7 +29,7 @@ description:
returns JSON inventory data.
I(Ohai) data is a bit more verbose and nested than I(facter).
version_added: "0.6"
options: []
options: {}
examples:
- code: ansible webservers -m ohai --tree=/tmp/ohaidata
description: "Retrieve I(ohai) data from all Web servers and store in one-file per host"

@ -27,6 +27,7 @@ description:
- A trivial test module, this module always returns 'pong' on successful
contact. It does not make sense in playbooks, but is useful from
C(/usr/bin/ansible)
options: {}
examples:
- code: ansible webservers -m ping
description: Test 'webservers' status

@ -4,6 +4,7 @@ DOCUMENTATION = '''
---
module: raw
short_description: Executes a low-down and dirty SSH command
options: {}
description:
- Executes a low-down and dirty SSH command, not going through the module
subsystem. This is useful and should only be done in two cases. The

@ -30,6 +30,7 @@ DOCUMENTATION = '''
---
module: setup
short_description: Gathers facts about remote hosts
options: {}
description:
- This module is automatically called by playbooks to gather useful
variables about remote hosts that can be used in playbooks. It can also be

Loading…
Cancel
Save