068ef0e979
module_formatter: re-instate code
2012-11-22 07:23:10 +01:00
caf003c813
DOCUMENTATION strings
2012-11-21 18:49:30 +01:00
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.
2012-11-11 00:14:08 -08:00
e32f4a0564
Move get_docstring from module_formatter into ansible/utils
2012-11-09 17:15:41 +01:00
6a5df97393
Manpage documentation ALSO should be sorted
2012-11-03 18:54:38 -04:00
626203a7c9
Module documentation should have options sorted
2012-11-03 18:52:59 -04:00
afa467e975
DOCUMENTATION: LaTeX template is back
...
ongoing work for the Booklet
2012-10-24 19:42:52 +02:00
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.
2012-10-20 12:12:07 -04:00
896be48ac9
Merge pull request #1367 from jpmens/mdtempl
...
Add support for Github-flavored Markdown to module_formatter
2012-10-18 16:59:18 -07:00
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
2012-10-18 13:49:19 +02:00
d4f89122f4
Add support for Github-flavored Markdown to module_formatter
...
- Uses HTML tables and Github-flavored code blocks (3 backticks)
2012-10-18 07:34:17 +02:00
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.
2012-10-12 16:27:01 -07:00
2786149bdc
Moving now from getopt to optparse
...
Let me know if we can move to another library instead ;-)
2012-10-11 18:14:38 +02:00
6d2f003ceb
Update formatter to not include orange blocks all over docsite page
2012-10-10 21:25:19 -04:00
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
2012-10-10 18:46:51 -04:00
ee679c0190
Unified document generator and make to generate JSON and JS files
2012-10-10 18:41:50 -04:00
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...
2012-10-09 12:23:30 +02:00
ba22ca13ba
man pages have wrong chapter number
2012-10-05 09:09:49 +02:00
c3f443f56c
fix sorting
2012-10-04 07:08:13 -04:00
761330b125
Fix module formatter indexing
2012-10-03 23:31:50 -04:00
85fb7c6d4b
Library functions and modules should be in the 3 man page section. Also the files should end in '.3'
2012-10-03 10:18:55 -04:00
ad5433b166
include version added info for individual fields
2012-10-02 22:36:27 -04:00
31a4fe412f
Complain when modules do not have documentation.
2012-09-30 21:10:07 -04:00
eb8a11237c
module_formatter can output lists of files to process (.rst and .tex)
2012-09-30 19:07:40 +02:00
e4338d0ca3
module_formatter now also uses Jinja2 trim_blocks
...
- Updated man template accordingly
- seem to have left in illegal char in facter DOCUMENTATION...
2012-09-30 15:06:18 +02:00
f5e0fbf65b
rst output template tweak for 'required'
2012-09-30 14:21:30 +02:00
b96da3e5b0
Merge pull request #1158 from jpmens/man01
...
documentation: man template: support empty options; add Version
2012-09-30 05:00:39 -07:00
61ee632d23
documentation: man template: support empty options; add Version to Makefile
2012-09-30 13:33:21 +02:00
80a9016636
module docs: fixed rst template
...
- notes is now supported
- multiline code examples are now supported (HTML rendering was off)
2012-09-30 13:20:24 +02:00
ce5dceab0e
Merge pull request #1128 from mavimo/devel
...
Added documentation to APT module
2012-09-28 16:12:58 -07:00
508e6ecf43
Merge pull request #1131 from jpmens/m-docs3
...
Module DOCUMENTATION for template, wait_for, and yum
2012-09-28 16:11:33 -07:00
a040807fd0
Module DOCUMENTATION for template, wait_for, and yum
2012-09-29 00:49:02 +02:00
94de4db928
Add JSON output format to DOCUMENTS and EXAMPLES parser
2012-09-28 22:38:27 +02:00
e0fb264a89
Module DOCUMENTATION: assemble, authorized_key, command, copy
...
plus a small fix in rst.j2 template
manpages generated & checked
modules.html generated & checked
2012-09-28 21:55:49 +02:00
62d038dca4
module_formatter fixes
2012-09-28 09:59:43 +02:00
0c855a85bc
fix module formatter output messages
2012-09-27 21:34:28 -04:00
405c097c43
Various fixes for the module documentation auto-generator
2012-09-27 21:30:32 -04:00
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.
2012-09-27 21:06:31 -04:00
d47e15a1f2
module_formatter in hacking/
2012-09-26 20:41:44 +02:00
ce01c3f7e7
Allow unicode transfer by not base64 encoding. Also: faster
2012-08-02 21:20:43 -04:00
4d4d0b90c5
readlink -f does not work on OS X. Replaced with a python solution
2012-07-30 21:35:24 +10:00
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
2012-07-30 13:18:28 +10:00
738cea9c93
small tweaks to --help for hacking/test-module
2012-07-23 19:33:26 -04:00
fc96b88205
Teach the test-module script about the new way MODULE_ARGS works in new-style modules.
2012-07-23 19:28:43 -04:00
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
2012-07-23 16:28:06 +00:00
ade0233d57
Refactoring test-module to be more like ansible.
2012-07-23 16:04:28 +00:00
d0f4358730
Port the copy module over to the new "common module" logic.
2012-07-21 17:07:42 -04:00
a94ec130d2
Common module code upgrades
2012-07-17 23:09:57 -04:00
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.
2012-07-17 22:34:52 -04:00
867b2437cc
consolidate output code in callbacks.py, from utils, remove extra functions
2012-07-15 10:12:49 -04:00
