Commit Graph

332 Commits (1609afbd12abb68d1434ee5ce56fe09e12a53fdb)

Author SHA1 Message Date
Michael DeHaan a5e8e10bb0 Removed unused things. 11 years ago
Michael DeHaan f4aa6c53bd Format module requirements as notes in Sphinx 11 years ago
Michael DeHaan eb0509fce7 Update the styling for the module pages slightly. 11 years ago
Michael DeHaan 35ec9f81ae Further modifications to the module formatter to adjust to the new theme, and some misc docs text corrections. 11 years ago
Michael DeHaan fe2d00d9d3 WIP on refactoring the module formatter code that we use to build the doc site with. 11 years ago
Michael DeHaan 31d0060de8 Standardized on yml suffix, so fix this example content filename. 11 years ago
Michael DeHaan 10009b0d3f Starting to refactor module formatter script.
Rename "jpfunc" to something more explanatory
11 years ago
Jens Rantil 2096c669d9 `env-setup` fix for zsh <= 4.3.10
This fixes issue #5026. It used to work. The regression was
introduced in 2b3381de7c.
11 years ago
Michael DeHaan 40429ee64e Code to limit display of version_added attributions in modules for modules that are too old to call out this information.
This does not generically apply to new arguments added to existing modules, just the version_added attribute on the top level modules.
11 years ago
Michael DeHaan 51e6f411f2 Docs: Fix the module formatter code that is intended to remove the 'historical' variable from showing up in version_added information (RST) 11 years ago
phy1729 2b3381de7c Add zsh support for working dir independant sourcing 11 years ago
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.
11 years ago
jctanner b6c1574f5c Merge pull request #4765 from mvo5/bugfix/fix-man-template
Fixes in the man template
11 years ago
Michael Vogt b8e641136a make comment lines in troff start with .\" and add a .SH EXAMPLES to the PLAINEXAMPLES section 11 years ago
Michael DeHaan d34a26e307 Undo an inadvertant revert from template changes so we still allow pythonic imports in module land. 11 years ago
Alan Fairless af40b19a2d Fix format string typo 11 years ago
James Tanner d154bf8781 Revert templating enhancements from 73dbab70 e6c28658 d409352c 9858b1f2 4587528b 9b1fe455 214b0b05 8d3db803 7f9504d1 5031104c 35cb9dc2 2bd8cb57 1e85c754 11 years ago
Michael DeHaan 9858b1f2f3 Enable imports to work on a snippet based system, allowing for instance a library of common EC2 functions
to be reused between modules.  See library/system/service and library/system/ping for initial examples.  Can
work the old way to just import 'basic', or can import the new way to import multiple pieces of code from
module_utils/.
11 years ago
Jharrod LaFon 996f87d898 Fixed usage comment to fish syntax for sourcing a file 11 years ago
Jharrod LaFon d0fe447fd1 Fixed incorrectly set PYTHONPATH 11 years ago
Jharrod LaFon dbfcd78790 Added an env-setup file for Fish 11 years ago
Michael DeHaan 5f18a53530 Fixup docs formatting. 11 years ago
Michael DeHaan 303a8ff563 Fix module path in readme file. 11 years ago
Michael DeHaan fa9635478b Fixing your YAML Seth :) 11 years ago
Michael DeHaan 955611bda8 Fixes #3294 11 years ago
Michael DeHaan 8b592c9d4b Add some whitespace to script 11 years ago
martin f. krafft 3839dcd56c Remove extra $ character
Signed-off-by: martin f. krafft <madduck@madduck.net>
11 years ago
martin f. krafft bbbc214ffb Remove bashisms, replace with POSIX constructs
This replaces double conditional brackets with single ones and gets ris
of bashisms, so that the tool should be sourcable from any POSIX shell.

Constructs like [ $foo = "$bar"* ] yield filesystem-globbing behaviour
according to POSIX. A compliant way is to use case statements.

Signed-off-by: martin f. krafft <madduck@madduck.net>
11 years ago
martin f. krafft 9f4988dbfd Quote variables in shell script
In case paths contain spaces, it's better to consistently quote
variables, and to use $() instead of `` for external invocations.

Signed-off-by: martin f. krafft <madduck@madduck.net>
11 years ago
martin f. krafft 4b9f8fc294 Replace external command with shell construct
dirname/basename do not need an external process, shell variable
expansion can be made to do the same a bit faster.

Signed-off-by: martin f. krafft <madduck@madduck.net>
11 years ago
martin f. krafft 013cd38929 Remove shebang line
The env-setup script is not intended to be run directly, so it does not
need a shebang line, which might even create the wrong expectations.

Signed-off-by: martin f. krafft <madduck@madduck.net>
11 years ago
Michael DeHaan 3f8aa8aec5 Fix up some module docs formatting errors. 11 years ago
Michael DeHaan b72109a04b Merge pull request #3273 from jlund/ansiblecc-to-ansibleworkscom
Update all ansible.cc references in the documentation to point to ansibleworks.com
11 years ago
Michael DeHaan 4553b3d0cf Merge branch 'generalise-hacking-dir-path-discovery' of git://github.com/madduck/ansible into envsetup2 11 years ago
Joshua Lund 0f81d1630f * Updated all ansible.cc references in the documentation to point
to ansibleworks.com
* Fixed a few misspelled words
11 years ago
Michael DeHaan af9b510769 Merge pull request #3220 from dsedivec/devel
Improve Markdown (and other) module doc output
11 years ago
trbs a4223e119d fixed x-bits in git 11 years ago
Dale Sedivec 7681b1ce68 Improve Markdown (and other) module doc output
- The html_ify filter now escapes HTML found in module documentation.
  THIS COULD AFFECT MORE THAN JUST MARKDOWN but I didn't see any modules
  expecting to use e.g. HTML entities or HTML tags in their
  documentation.

- The markdown_ify filter (used as jpfunc in markdown.j2) escapes at
  least a few Markdown in-line formatting characters.

- Improvements to markdown.j2:

    - Call jpfunc on the module name heading so that it gets escaped for
      Markdown (e.g. my_module_name becomes my\_module\_name).

    - Added paragraph breaks between paragraphs in the description.

    - Added examples heading, which is consistent with the notes heading
      below it.
11 years ago
martin f. krafft 3b008d6fa6 Expand usage synopsis
'source' is actually a "bashism" and the POSIX-way of sourcing a file
uses the single dot (which is arguably less readable). Both yield the
same result, and since the script may now also be sourced from
within the hacking directory, this commit expands the usage synopsis
accordingly.

Signed-off-by: martin f. krafft <madduck@madduck.net>

Conflicts:
	hacking/env-setup
11 years ago
martin f. krafft 581dea70d1 Generalise determination of hacking directory path
Bash needs a special case to determine the dirname of the sourced path
(the hacking dir), but in all other cases, using $0 allows the script to
be sourced also from within the hacking directory, not only from its
parent.

Signed-off-by: martin f. krafft <madduck@madduck.net>
11 years ago
Michael DeHaan 88102df07c Show 'yes' and 'no' in choices on docs page. 11 years ago
Nicolas Grilly 75ceb80572 Escape args injected in new style modules 11 years ago
Michael DeHaan 9ca0289dee Fixup the module formatter to explain the EXAMPLES string as well. 11 years ago
Jan-Piet Mens eeb80c695f Add Requirements to rst template, ansible-doc
tweak position & look of Requirements in rst
tweak APT's notes as per anhj's wish
11 years ago
Michael DeHaan ce67588dcf Fix module doc organization 11 years ago
Michael DeHaan 627b6a0455 Have 1.2 clear in docs 11 years ago
Michael DeHaan 391fb98ee2 Allow modules to be categorized, and also sort them when generating the documentation. 11 years ago
Michael DeHaan af2fb56a10 Changes to allow WANT_JSON to allow JSON to non-Python modules 11 years ago
Michael DeHaan bac3449db7 Restructure hacking readme. 11 years ago
Michael DeHaan e2d9e1b5c2 Convert 'hacking' instructions to markdown, add more info. 11 years ago
Michael DeHaan 148d8859ba Docs on parameterized roles, make document generation output less noisy 11 years ago
Marco Vito Moscaritolo a53259a797 Fixed option validation error
Fixed error on validation that block javascript documentation generation.
11 years ago
Michael DeHaan b066e9c15c Remove authors file from version control (can still be built from 'make authors') 11 years ago
Cristian Ciupitu 29aaa5e693 module_formatter.return_data: use UTF-8 encoding
The text parameter can contain non-ASCII characters, so we'll encode it
using UTF-8. For example the DOCUMENTATION of the bzr module has such
characters in the name of the author.
11 years ago
Sam Kottler 86d420f481 Use verbose 'source' to make the document easier to read 11 years ago
Michael DeHaan 03db6ef24a Slightly more self-explanatory output for ./hacking/env-setup 11 years ago
Michael DeHaan fa550f3d7e Adding a script to auto-generate an authors file, runnable from 'make authors', which is called from 'make docs/webdocs'. 12 years ago
Michael DeHaan e51707711c Merge pull request #2120 from jpmens/doc_ex1
Add support for additional EXAMPLES string in Ansible modules
12 years ago
Yves Dorfsman dfdc5bda4b Prevents PATH, PYTHONPATH etc... to be re-added. 12 years ago
Jan-Piet Mens 396a07bcc7 Add support for additional EXAMPLES string in Ansible modules
return DOC and EXAMPLES as a list
add moduledev explanation
more
12 years ago
Michael DeHaan b3eb1f32e3 update hacking/test_module script to be aware of complex arguments, though it does not pass them. 12 years ago
Michael DeHaan 0ae7f996f5 Make sure all the lookup plugins are documented. 12 years ago
Les Aker ee274b5816 fixed shebang in hacking test-module 12 years ago
junyoung a2aacaaec8 whitespaces in FULL_PATH cause an error to get ANSIBLE_PATH 12 years ago
Daniel Hokka Zakrisson a117944d0f Make env-setup work on Python 3 12 years ago
Blair Zajac ec5f6ae246 hacking/env-setup: remove unused sys import. 12 years ago
Dag Wieers 66fb7fd9de Make use of yes/no booleans in playbooks
At the moment Ansible prefers yes/no for module booleans, however booleans in playbooks are still using True/False, rather than yes/no. This changes modifies boolean uses in playbooks (and man pages) to favor yes/no rather than True/False.

This change includes:

- Adaptation of documentation and examples to favor yes/no
- Modification to manpage output to favor yes/no (the docsite output already favors yes/no)
12 years ago
Jan-Piet Mens f9755ca36d mail module: add MIME attachments, port and addresses with phrases
Add HTML-escaping to code examples in rST tempate of module-formatter
 Add support for specifying port, addresses with phrases and attaching files
 Add support for custom headers and document version_added for new options
 X-Mailer header added :)
 protect empty address lists & attachment list, and add bcc
12 years ago
Stephen Fromm 6a68d3813f Set LANG in module_common.py
Add constant DEFAULT_MODULE_LANG that defaults to C.  Can be set via
environment variable ANSIBLE_MODULE_LANG or configuration variable
module_lang.  Updated test-module to have same behavior.
12 years ago
Michael DeHaan dd5a8474f8 Have module formatter ignore more types of files. 12 years ago
Jan-Piet Mens 068ef0e979 module_formatter: re-instate code 12 years ago
Jan-Piet Mens caf003c813 DOCUMENTATION strings 12 years ago
Stephen Fromm 06e54c0b97 Add ability to specify syslog facility for modules
Update constants.py so that one can specify environmental variable
ANSIBLE_SYSLOG_FACILITY or syslog_facility in ansible.cfg to define
the syslog facility to use.  Alternatively, you can specify
ansible_syslog_facility in inventory.  Runner now replaces
the syslog facility in the openlog() call with the default or
the injected variables ansible_syslog_facility.

This also updates hacking/test-module to behave similarly.
12 years ago
Jan-Piet Mens e32f4a0564 Move get_docstring from module_formatter into ansible/utils 12 years ago
Michael DeHaan 6a5df97393 Manpage documentation ALSO should be sorted 12 years ago
Michael DeHaan 626203a7c9 Module documentation should have options sorted 12 years ago
Jan-Piet Mens afa467e975 DOCUMENTATION: LaTeX template is back
ongoing work for the Booklet
12 years ago
Michael DeHaan 4104478abd Added 'script', a module that can push and insantly run a remote script. Replaces the need to copy+command.
This is a bit of a rough draft, some error handling still needs to be added.
12 years ago
Michael DeHaan 896be48ac9 Merge pull request #1367 from jpmens/mdtempl
Add support for Github-flavored Markdown to module_formatter
12 years ago
Jan-Piet Mens 575459465e module_formatter: .rst now correctly handles code examples
- fixed template (it was the template), adding indentation with Jinja2
 - added description of code examples to man-page template (was missing)
 - fixed fireball, cron, and debug module examples to confrom
12 years ago
Jan-Piet Mens d4f89122f4 Add support for Github-flavored Markdown to module_formatter
- Uses HTML tables and Github-flavored code blocks (3 backticks)
12 years ago
Stephen Fromm 60f06c36b3 Miscellaneous fixes to module_formatter.py
Try to autodetect MODULEDIR, instead of hardcoded path in jpmens
homedir.
Check if MODULEDIR exists; exit if it doesn't.
Rewrite boilerplate() to use DOCUMENTATION.yaml in examples/.  This
makes use of tbielawa's recent change that added this example file.
This also fixes -G so that it works.  boilerplate() was commented out
before.
12 years ago
Dag Wieers 2786149bdc Moving now from getopt to optparse
Let me know if we can move to another library instead ;-)
12 years ago
Michael DeHaan 6d2f003ceb Update formatter to not include orange blocks all over docsite page 12 years ago
Michael DeHaan 110244d7b4 Merge branch 'remove-argparse' of git://github.com/dagwieers/ansible into devel
Conflicts:
	hacking/module_formatter.py

Don't run webdocs build when building packages
12 years ago
Marco Vito Moscaritolo ee679c0190 Unified document generator and make to generate JSON and JS files 12 years ago
Dag Wieers 2dcd0846ab Use getopt instead of argparse
On RHEL5 and RHEL6 there is not argparse, and 'make rpm' fails because of this.
With this change it works, and I can test and fix my own documentation...
12 years ago
Jan-Piet Mens ba22ca13ba man pages have wrong chapter number 12 years ago
Michael DeHaan c3f443f56c fix sorting 12 years ago
Michael DeHaan 761330b125 Fix module formatter indexing 12 years ago
Tim Bielawa 85fb7c6d4b Library functions and modules should be in the 3 man page section. Also the files should end in '.3' 12 years ago
Michael DeHaan ad5433b166 include version added info for individual fields 12 years ago
Michael DeHaan 31a4fe412f Complain when modules do not have documentation. 12 years ago
Jan-Piet Mens eb8a11237c module_formatter can output lists of files to process (.rst and .tex) 12 years ago
Jan-Piet Mens e4338d0ca3 module_formatter now also uses Jinja2 trim_blocks
- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
12 years ago
Jan-Piet Mens f5e0fbf65b rst output template tweak for 'required' 12 years ago
Michael DeHaan b96da3e5b0 Merge pull request #1158 from jpmens/man01
documentation: man template: support empty options; add Version
12 years ago
Jan-Piet Mens 61ee632d23 documentation: man template: support empty options; add Version to Makefile 12 years ago
Jan-Piet Mens 80a9016636 module docs: fixed rst template
- notes is now supported
- multiline code examples are now supported (HTML rendering was off)
12 years ago
Michael DeHaan ce5dceab0e Merge pull request #1128 from mavimo/devel
Added documentation to APT module
12 years ago
Michael DeHaan 508e6ecf43 Merge pull request #1131 from jpmens/m-docs3
Module DOCUMENTATION for template, wait_for, and yum
12 years ago
Jan-Piet Mens a040807fd0 Module DOCUMENTATION for template, wait_for, and yum 12 years ago
Marco Vito Moscaritolo 94de4db928 Add JSON output format to DOCUMENTS and EXAMPLES parser 12 years ago
Jan-Piet Mens e0fb264a89 Module DOCUMENTATION: assemble, authorized_key, command, copy
plus a small fix in rst.j2 template
  manpages generated & checked
  modules.html generated & checked
12 years ago
Jan-Piet Mens 62d038dca4 module_formatter fixes 12 years ago
Michael DeHaan 0c855a85bc fix module formatter output messages 12 years ago
Michael DeHaan 405c097c43 Various fixes for the module documentation auto-generator 12 years ago
Michael DeHaan 83f277cfe6 Various tweaking to get the module formatter to work for 'make docs' in the docs project. Likely the templates for other module formatting types will have to change
by the time I'm done.
12 years ago
Jan-Piet Mens d47e15a1f2 module_formatter in hacking/ 12 years ago
Michael DeHaan ce01c3f7e7 Allow unicode transfer by not base64 encoding. Also: faster 12 years ago
Will Thames 4d4d0b90c5 readlink -f does not work on OS X. Replaced with a python solution 12 years ago
willthames 6219fc4932 env-setup no longer needs to be run from the ansible directory, it can be run from anywhere
env-setup now takes a -q argument to run in quiet mode
12 years ago
Michael DeHaan 738cea9c93 small tweaks to --help for hacking/test-module 12 years ago
Michael DeHaan fc96b88205 Teach the test-module script about the new way MODULE_ARGS works in new-style modules. 12 years ago
bradobro e8583833a7 test-module uses optparse with --debugger
Refactored hacking/test-module

1. uses optparse

2. has --debugger option

tested only with pdb on Python 2.7
12 years ago
bradobro ade0233d57 Refactoring test-module to be more like ansible. 12 years ago
Michael DeHaan d0f4358730 Port the copy module over to the new "common module" logic. 12 years ago
Michael DeHaan a94ec130d2 Common module code upgrades 12 years ago
Michael DeHaan 9006d4557d Added code to allow insertion of boilerplate into modules to make them able to share lots of code, the result
should be a huge reduction of total ansible source, at a slight cost of difficulty in original module development.

We need to apply this now to all modules, but may need to have some exemptions to things like command, which should
subclass this module.
12 years ago
Michael DeHaan 867b2437cc consolidate output code in callbacks.py, from utils, remove extra functions 12 years ago
Peter Sankauskas f9a14cfec1 Adding a missing '~' to use the user's home directory instead of the root file system for the module arguments 12 years ago
Michael DeHaan 6341361a5b Clarify that stderr WILL crash your module. Can't redirect because if we do we lose tracebacks
from modules remotely when they fail to parse, and this is VERY useful data.
12 years ago
Michael DeHaan 36e454c52f Because paramiko using a pty can't distinguish stderr and stdout, remove handling that
treated -D as a way to show stderr, and make sure modules don't include things on stderr.
Update docs and test module script to come into line.
12 years ago
Michael DeHaan 533c2c6126 Make it possible to use facts from hosts in templates for other hosts.
It works like this:

{{ hostvars['127.0.0.1']['ansible_eth0']['ipv4']['address'] }}
12 years ago
Tim Bielawa e9e8417735 Update hacking with MANPATH. Correct hacking README details. 12 years ago
Michael DeHaan 82bd75c1e0 Update env-setup script to make it work better 12 years ago
Michael DeHaan be55145a1e Initial crack at the file module 12 years ago
Michael DeHaan a735dd2b17 Added the 'test-module' script, useful for testing modules without running them in Ansible. 12 years ago
Michael DeHaan 85e0de5bb2 Move print statements out of playbook.py and back into CLI so we can simplify playbook operations
independent of output, and can also see all the output nicely grouped together if we want
to reformat it or make summaries of statistics.
13 years ago
Tim Bielawa c5f8bc9d79 Don't set ANSIBLE_HOSTS inside the env-setup script 13 years ago
Tim Bielawa f2c2786a14 Update constants.py to pull module path and the hosts file from the
environment (ANSIBLE_{LIBRARY,HOSTS}) if defined.

Update manpages to represent this.

Also update the env-setup script to set ANSIBLE_{LIBRARY,HOSTS}.
13 years ago
Tim Bielawa 6343aa6214 Add environment updating script 'env-setup' to facilitate running ansible from a git checkout. 13 years ago