From 9991dfee6ccf20c0fa97485d8134bc174c3938e7 Mon Sep 17 00:00:00 2001 From: Jan-Piet Mens Date: Tue, 16 Oct 2012 16:06:00 +0200 Subject: [PATCH] Indicate module_formatter can produce boilerplate DOCUMENTATION add ./hacking/ --- docsite/rst/moduledev.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docsite/rst/moduledev.rst b/docsite/rst/moduledev.rst index 4f71ad9a6f3..8e6a19bc0d4 100644 --- a/docsite/rst/moduledev.rst +++ b/docsite/rst/moduledev.rst @@ -328,8 +328,9 @@ Here's a correctly formatted YAML document we could use for a .. literalinclude:: ../DOCUMENTATION.yaml This is available in the 'examples/' directory of the of the Ansible -github repository. You can copy it into your module and use it as a -starting point when writing your own docs. +github repository, and you can have that generated with +``./hacking/module_formatter.py -G``. You can copy it into your module and use +it as a starting point when writing your own docs. Include it in your module file like this::