Added return values documentation to modules

hacking/module_formatter.py

@@ -289,6 +289,7 @@ 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
 
     # here is where we build the table of contents...
 

hacking/templates/rst.j2

@@ -106,6 +106,21 @@ Examples
 {% endif %}
 {% endif %}
 
+
+{% if returndocs %}
+Return Values
+-------------
+
+Common return values are documented here ::doc::`common_return_values`, the following are the fields unique to this module:
+
+.. raw:: html
+<pre>
+@{ returndocs }@
+</pre>
+
+::
+{% endif %}
+
 {% if notes %}
 {% for note in notes %}
 .. note:: @{ note | convert_symbols_to_format }@
@@ -120,7 +135,7 @@ This is a Core Module
 ---------------------
 
 This source of this module is hosted on GitHub in the `ansible-modules-core <http://github.com/ansible/ansible-modules-core>`_ repo.
-  
+
 If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansible, first look in the `issue tracker at github.com/ansible/ansible-modules-core <http://github.com/ansible/ansible-modules-core>`_ to see if a bug has already been filed.  If not, we would be grateful if you would file one.
 
 Should you have a question rather than a bug report, inquries are welcome on the `ansible-project google group <https://groups.google.com/forum/#!forum/ansible-project>`_ or on Ansible's "#ansible" channel, located on irc.freenode.net.   Development oriented topics should instead use the similar `ansible-devel google group <https://groups.google.com/forum/#!forum/ansible-devel>`_.
@@ -135,7 +150,7 @@ This is an Extras Module
 ------------------------
 
 This source of this module is hosted on GitHub in the `ansible-modules-extras <http://github.com/ansible/ansible-modules-extras>`_ repo.
-  
+
 If you believe you have found a bug in this module, and are already running the latest stable or development version of Ansible, first look in the `issue tracker at github.com/ansible/ansible-modules-extras <http://github.com/ansible/ansible-modules-extras>`_ to see if a bug has already been filed.  If not, we would be grateful if you would file one.
 
 Should you have a question rather than a bug report, inquries are welcome on the `ansible-project google group <https://groups.google.com/forum/#!forum/ansible-project>` or on Ansible's "#ansible" channel, located on irc.freenode.net.   Development oriented topics should instead use the similar `ansible-devel google group <https://groups.google.com/forum/#!forum/ansible-devel>`_.