diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index 6d595c634d6..c3aca94949c 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -289,7 +289,10 @@ def process_module(module, options, env, template, outputname, module_map, alias doc['now_date'] = datetime.date.today().strftime('%Y-%m-%d') doc['ansible_version'] = options.ansible_version doc['plainexamples'] = examples #plain text - doc['returndocs'] = returndocs + if returndocs: + doc['returndocs'] = yaml.safe_load(returndocs) + else: + doc['returndocs'] = None # here is where we build the table of contents... diff --git a/hacking/templates/rst.j2 b/hacking/templates/rst.j2 index 6d3c21f4240..6873c3fea58 100644 --- a/hacking/templates/rst.j2 +++ b/hacking/templates/rst.j2 @@ -111,18 +111,57 @@ Examples Return Values ------------- -Common return values are documented here ::doc::`common_return_values`, the following are the fields unique to this module: +Common return values are documented here :doc:`common_return_values`, the following are the fields unique to this module: .. raw:: html -
-
- @{ returndocs }@ -- +
name | +despcription | +returned | +type | +sample | +||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@{ entry }@ | +@{ returndocs[entry].description }@ | +@{ returndocs[entry].returned }@ | +@{ returndocs[entry].type }@ | +@{ returndocs[entry].sample}@ | +||||||||||
contains: | +
+
|