Commit graph

11 commits

Author SHA1 Message Date
Jeff Geerling
bb2cdb11fd Mention shell module in command documentation
Users who use the command module for pretty much all shell commands may be stymied when they try using a command with <, >, $VAR, etc., and not know that they can use the `shell` module instead. This documentation fix clarifies this.
2014-01-27 14:56:52 -06:00
Stoned Elipot
b85743e228 shell module: document removes option and sync with command module doc 2013-12-25 12:12:11 +01:00
James Tanner
6000d636b3 Fixes #5023 Convert all modules to use new snippet import pattern 2013-12-02 15:11:23 -05:00
Michael DeHaan
36effd237c There's a cleaner way to do this, commit to module formatter pending.
Revert "No longer need to reference 'version_added' in docs for these, as this was quite a while ago."

This reverts commit ff0a41d446.
2013-11-27 21:23:03 -05:00
Michael DeHaan
ff0a41d446 No longer need to reference 'version_added' in docs for these, as this was quite a while ago. 2013-11-27 21:19:32 -05:00
Michael DeHaan
f7c3975f21 Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
2013-11-18 18:55:49 -05:00
Jesse Keating
36ca709849 Allow for relative paths by using abspath
relative pathing comes in handy on occasion, particularly when
delegating to localhost and running some command out of your playbook
repo. Making use of os.path.abspath will allow for the full path to
chdir and executable to be discovered if not provided.
2013-08-20 22:48:42 -07:00
Jan-Piet Mens
30d641094b Docs: consistently format playbook EXAMPLES 2013-06-17 08:53:46 +02:00
Jan-Piet Mens
5c69918d53 DOCS: standardize on EXAMPLES (a.k.a. Docs-JumboPatch JetLag Edition)
Migrated all examples: in DOCUMENTATION=''' string to standalone EXAMPLES=''' string
  Added deprecation warning to moduledev.rst and remove deprecated example from it
  Fixed up a few typos and uppercased some acronyms.
  add consistency to how EXAMPLES are formatted
2013-06-15 20:54:25 +02:00
Stoned Elipot
f9cff3c444 No need to expanduser() command's chdir argument twice 2013-05-29 17:05:11 +02:00
Michael DeHaan
391fb98ee2 Allow modules to be categorized, and also sort them when generating the documentation. 2013-04-28 15:03:45 -04:00