Merge documentation for Jay Ross (ansible#43)

* Adding webdocs support * major redo of doc generation * final changes to documentation * Adding webdocs support * major redo of doc generation * major redo of doc generation Change-Id: Ic46dbc4ae1431a9ac882c88fbf0af56dd8b40d9a
DimensionDataResearch · Sep 15, 2016 · 38fadf8 · 38fadf8
1 parent 55e63ed
commit 38fadf8
Show file tree

Hide file tree

Showing 5 changed files with 577 additions and 0 deletions.
diff --git a/docs/Ansible_Webdocs_Notes.txt b/docs/Ansible_Webdocs_Notes.txt
@@ -0,0 +1,37 @@
+
+Ansible Docstring Rules
+=================================
+
+* Each module must have a short_description section
+
+* short_description must be a string and not a list
+
+    This works:
+         short_description: foo, foo, foo
+
+    But this will fail miserably:
+         short_description:
+           - foo, foo, foo
+
+* Each module must have a description section
+
+* Ansible webdocs do not care about line lengths
+
+* All lines must have some sort of leader
+
+    For example, this works:
+         description:
+           - foo, foo, foo
+           - bar, bar, bar
+
+    However, this will fail:
+         description:
+           - foo, foo, foo
+             bar, bar, bar
+
+(note the lack of - )
+
+---
+
+Jay Riddell
+7/8/16