Michael DeHaan
4658a98066
Remove line about undocumented variables as they should be documented :)
2013-12-27 14:50:50 -05:00
Michael DeHaan
3ef228a906
Merge pull request #5387 from sa2ajj/fix-docs-refs
...
fix various documentation xrefs
2013-12-27 11:45:54 -08:00
Michael DeHaan
d84b236ad5
Merge pull request #5436 from jkleckner/fix-fail-doc-example
...
Fix documentation example for the fail module
2013-12-27 11:21:51 -08:00
Mikhail Sobolev
64652fa6ab
fix various documentation xrefs
2013-12-27 18:21:08 +02:00
Jim Kleckner
edca1d69cf
Fix documentation example for the fail module
...
The example for the fail module doesn't work:
http://www.ansibleworks.com/docs/modules.html#fail
The current text shows:
- fail: msg="The system may not be provisioned according to the CMDB status."
when: "{{ cmdb_status }} != 'to-be-staged'"
The "when" documentation indicates that the argument is already a Jinja2
expression:
http://www.ansibleworks.com/docs/playbooks_conditionals.html#the-when-statement
Thus, the following is
when: cmdb_status != "to-be-staged"
is preferred even though the following could work but generates a
deprecation warning:
when: {{cmdb_status != "to-be-staged"}}
2013-12-26 16:32:32 -08:00
Michael DeHaan
af98ce8433
Add topics index to installation page.
2013-12-26 14:35:57 -05:00
Michael DeHaan
eec9b6c8b8
Fix a intra-doc link.
2013-12-26 14:35:57 -05:00
Michael DeHaan
bde41bac35
Fix some small docsite formatting things.
2013-12-26 14:35:57 -05:00
Michael DeHaan
1c29f043b4
Add contents to various pages with more than one topic per page.
2013-12-26 14:35:57 -05:00
Mikhail Sobolev
8733b5da8b
fix short/full description for elasticache
2013-12-26 14:35:57 -05:00
Mikhail Sobolev
84948292f3
include short_description in the module page's title
2013-12-26 14:35:57 -05:00
Mikhail Sobolev
8b7327a2f6
make examples/DOCUMENTATION.yml a link
2013-12-26 14:35:57 -05:00
Michael DeHaan
cfcdc3403e
Use task names in examples.
2013-12-26 13:46:09 -05:00
Michael DeHaan
4765032fcb
Merge branch 'devel' of git://github.com/beefsalad/ansible into devel
2013-12-26 13:41:42 -05:00
Michael DeHaan
1260225fc9
Merge pull request #5427 from bcoca/template_docs2
...
added more usefull example for jinja2 overrides
2013-12-26 10:30:44 -08:00
Michael DeHaan
1847a73b89
Merge pull request #5425 from mmoya/docfix
...
Missing "is" in file module description
2013-12-26 10:29:42 -08:00
beefsalad
5b2fda6fa6
added descriptions for yum options
...
Updated main description to state that the yum module will handle package groups. Added descriptions for each example, as it is unclear to (some) users that @Name implies a group install.
2013-12-26 12:25:52 -06:00
Brian Coca
488ef22f5e
added more usefull example for jinja2 overrides (this one is actually
...
used)
Signed-off-by: Brian Coca <briancoca+dev@gmail.com>
2013-12-26 12:01:41 -05:00
Michael DeHaan
81bc44ccc2
Don't show tracebacks on Control-C.
2013-12-26 11:41:05 -05:00
Maykel Moya
0711447d3a
Missing "is" in file module description
2013-12-26 12:34:46 +01:00
Michael DeHaan
1119ecebee
Make AnsibleWorks a hyperlink in docs footer.
2013-12-25 21:36:23 -05:00
Michael DeHaan
83d298accc
Add note about how to submit doc changes to generated module docs, limit TOC depth for module category list.
2013-12-25 21:29:54 -05:00
Michael DeHaan
d6e28b4c57
Enable the very cool "Edit on GitHub" links for pages where the RST is straight
...
out of github.
2013-12-25 21:05:25 -05:00
Mikhail Sobolev
fce90e0370
use rst formatting for sphinx part
2013-12-25 21:20:11 +02:00
Mikhail Sobolev
8b680343dd
fix example formatting
2013-12-25 21:19:00 +02:00
Mikhail Sobolev
1713013dba
provide sections and local TOC for module documentation
2013-12-25 21:19:00 +02:00
Mikhail Sobolev
7965d331f3
do not produce too deep toc for category lists
2013-12-25 21:19:00 +02:00
Mikhail Sobolev
af1f8db51d
remove trailing whitespaces
2013-12-25 21:19:00 +02:00
Michael DeHaan
a5e8e10bb0
Removed unused things.
2013-12-25 14:17:47 -05:00
Michael DeHaan
f4aa6c53bd
Format module requirements as notes in Sphinx
2013-12-25 14:12:00 -05:00
Michael DeHaan
eb0509fce7
Update the styling for the module pages slightly.
2013-12-25 14:06:55 -05:00
Michael DeHaan
fb5a342968
Merge pull request #5420 from levigross/devel
...
Fixed syntax error and removed unused imports
2013-12-25 10:53:35 -08:00
Michael DeHaan
e8d9f58949
Merge pull request #5419 from stoned/shell-module-doc-fix
...
shell module: document removes option and sync with command module doc
2013-12-25 10:52:46 -08:00
Michael DeHaan
0bdf615612
User report of DO not taking underscores so tweaking docs
2013-12-25 13:51:56 -05:00
Michael DeHaan
aa8beadec3
Fix a documentation item.
2013-12-25 13:50:15 -05:00
Michael DeHaan
de8520da21
Add analytics to new docs theme.
2013-12-25 13:38:40 -05:00
Michael DeHaan
35ec9f81ae
Further modifications to the module formatter to adjust to the new theme, and some misc docs text corrections.
2013-12-25 13:24:29 -05:00
Michael DeHaan
fe2d00d9d3
WIP on refactoring the module formatter code that we use to build the doc site with.
2013-12-25 13:24:29 -05:00
Michael DeHaan
31d0060de8
Standardized on yml suffix, so fix this example content filename.
2013-12-25 13:24:29 -05:00
Michael DeHaan
10009b0d3f
Starting to refactor module formatter script.
...
Rename "jpfunc" to something more explanatory
2013-12-25 13:24:29 -05:00
Levi Gross
dc6a26123b
Fixed syntax error and removed unused imports
2013-12-25 11:04:47 -05:00
Stoned Elipot
b85743e228
shell module: document removes option and sync with command module doc
2013-12-25 12:12:11 +01:00
Michael DeHaan
c44b876c82
Merge pull request #5415 from jlund/galaxy-readme
...
Fixing a small typo in the Galaxy README template
2013-12-24 15:57:57 -08:00
Michael DeHaan
080296a028
Merge pull request #5414 from jlund/mode-typo
...
Fixing a typo in the Amazon Web Services and Rackspace Cloud guides
2013-12-24 15:57:09 -08:00
Michael DeHaan
b0578c82c2
Merge pull request #5416 from sa2ajj/more-minor-doc-fixes
...
More minor doc fixes
2013-12-24 15:56:50 -08:00
Michael DeHaan
99daaa5bb5
Re-add the playbook introduction which was replaced earlier.
2013-12-24 18:51:46 -05:00
Mikhail Sobolev
d1d20b7065
add a link to the resources section
2013-12-25 01:20:00 +02:00
Mikhail Sobolev
34f65f8e84
fix the link formatting
2013-12-25 01:19:41 +02:00
Michael DeHaan
1a106ac419
Add copy of Sphinx RTD theme so we can modify if needed and everyone has a consistent copy.
2013-12-24 18:10:19 -05:00
Michael DeHaan
e00262c1b3
Split content into subpages.
2013-12-24 18:05:41 -05:00
