From dff7b0fdbcaf01f33023e485bb7d43b025aa6ff7 Mon Sep 17 00:00:00 2001
From: Michael DeHaan
Date: Thu, 27 Sep 2012 21:33:55 -0400
Subject: [PATCH] Tweaking module docs as a result of integrating the new
module docs generator
---
Makefile | 2 +-
README.md | 4 +
YAMLSyntax.html | 36 +-
_themes/bootstrap/layout.html | 29 +-
api.html | 36 +-
bestpractices.html | 36 +-
conf.py | 6 +-
examples.html | 36 +-
genindex.html | 36 +-
gettingstarted.html | 38 +-
index.html | 241 +-----------
moduledev.html | 37 +-
modules.html | 710 ++++++++++++++--------------------
patterns.html | 36 +-
playbooks.html | 36 +-
playbooks2.html | 36 +-
rst/index.rst | 161 +-------
rst/modules/file.rst | 107 ++---
rst/modules/get_url.rst | 84 ++--
rst/modules/lineinfile.rst | 116 ++++--
rst/modules/raw.rst | 25 +-
rst/modules/setup.rst | 136 +------
rst/who_uses_ansible.rst | 38 --
search.html | 36 +-
searchindex.js | 2 +-
who_uses_ansible.html | 30 +-
26 files changed, 591 insertions(+), 1499 deletions(-)
delete mode 100644 rst/who_uses_ansible.rst
diff --git a/Makefile b/Makefile
index 5ab48918f05..0fbb81d02eb 100644
--- a/Makefile
+++ b/Makefile
@@ -26,5 +26,5 @@ clean:
.PHONEY: docs clean
modules: $(FORMATTER) ../ansible/hacking/templates/rst.j2
- $(FORMATTER) -t rst --template-dir=../ansible/hacking/templates --module-dir=../ansible/library -o rst/modules/
+ $(FORMATTER) -t rst --module-dir=../ansible/library -o rst/modules/
diff --git a/README.md b/README.md
index b0125f8abc5..73b569c138b 100644
--- a/README.md
+++ b/README.md
@@ -10,6 +10,10 @@ do a docs build and push the static files.
If you do not want to learn RST format (ReStructured Text), you can also file issues
on the documentation project.
+Note that module documentation can actually be generated from a DOCUMENTATION docstring
+in the modules directory, so corrections to modules written as much need to be made
+in the main project in the module source, rather than in the documentation for the module.
+
Author
======
diff --git a/YAMLSyntax.html b/YAMLSyntax.html
index 5cb4c5d4e26..7d6ac783266 100644
--- a/YAMLSyntax.html
+++ b/YAMLSyntax.html
@@ -7,7 +7,7 @@
- YAML Syntax — Ansible - SSH-Based Configuration Management & Deployment
+ YAML Syntax — Ansible Documentation
@@ -29,7 +29,7 @@
-
+
-
-
-
© Copyright 2012 Michael DeHaan.
- Last updated on Sep 23, 2012.
+ Last updated on Sep 27, 2012.
-
+