Brian Coca
d3fe9b3194
Merge pull request #11084 from echiu64/devel
...
More complex example of using test-module
2015-07-21 21:29:25 -04:00
Abhijit Menon-Sen
8342cc6b61
Fix existing typo, remove trailing space added by PR commit
2015-07-22 06:53:59 +05:30
Will Thames
b05485d4b3
Add options to control output and execution of test-module
...
test-module is useful but sometimes you want to edit the
result before running it to e.g. set a debug point.
Added a noexecute option (i.e. just create the module script, don't
run it) and an output option to choose the filename of the result.
2015-07-22 06:50:37 +05:30
Brian Coca
c40541964b
Merge pull request #11637 from bcoca/moar_docs
...
Moar docs
2015-07-20 22:31:34 -04:00
Brian Coca
740f15cb0d
just remove version_added when to old, not the whole option!
2015-07-20 22:31:20 -04:00
Brian Coca
9de086d16d
removed merges from count
2015-07-18 22:49:50 -04:00
Brian Coca
173f27531c
moar docs
...
added docs for new v2 features
restructures modules bar and core/extras info into their own pages
changed templates to refer to the new pages
added some missing ansible.cfg options
more info on gathering setting
2015-07-17 22:53:11 -04:00
Brian Coca
6ba706f753
minor doc reformatting
...
now version_added < 1.3 does not get shown, up from 1.0
option's version_added is also now filterd against this threshold
module version_added is more prominent
exaples now uses pure rst instead of intermingled with html formatting
aliases now shown in description for options
bad version fields now throw warnings instead of exceptions
ansible-doc errors now show traceback in very very verbose mode, for easier debugging
2015-07-17 10:07:22 -04:00
Brian Coca
811b10d132
docs will not mention versions older than 1.5
2015-07-17 10:07:22 -04:00
Brian Coca
1aeb66148b
actually now does what it says as it was just sorting by name
2015-07-17 10:07:22 -04:00
Gerard Lynch
2f51f3bbc5
updated to use new loader
2015-07-17 11:44:00 +01:00
Brian Coca
95bf78d0e7
Merge pull request #11618 from halberom/test-module
...
hacking/test-module, updated to new location and non-classness of module_common
2015-07-16 19:01:35 -04:00
Gerard Lynch
3c7a502c50
updated to new location and non-classness of module_common
2015-07-16 23:56:18 +01:00
Brian Coca
f146c7680f
Merge pull request #10928 from gimoh/test-module-default-python
...
Use same interpreter for test-module and module it runs
2015-07-16 18:48:00 -04:00
Marc Abramowitz
3b0524e67d
hacking/test-module: Style nit
2015-07-02 18:59:58 +00:00
Marc Abramowitz
5466ff8907
hacking/test-module: Deal with move of parse_kv
2015-07-02 18:58:57 +00:00
Marc Abramowitz
ea6ec3bf2c
Make test-module work in v2
...
- `jsonify` moved from `ansible.utils` to `ansible.parsing.utils.jsonify`
- I don't see `ansible.utils.parse_json` anymore so I used `json.loads`.
2015-07-02 18:16:33 +00:00
Brian Coca
0826106441
minor docs reformat
...
- clearer 'version added' for module options, now it sits under the option name
- made notes a section, so it now appears in toc
- moved requirements and made it a list, more prominent and more readable
2015-06-03 22:19:26 -04:00
James Cammarata
2bad888f28
Merge branch 'v2_final' into devel_switch_v2
...
Conflicts:
lib/ansible/inventory/__init__.py
lib/ansible/modules/core
lib/ansible/utils/__init__.py
lib/ansible/utils/module_docs.py
2015-05-28 15:26:03 -05:00
Edwin Chiu
aef76cc701
More complex example of using test-module
2015-05-28 14:43:25 -04:00
Florian Apolloner
3010190592
Fixing up the hacking module_formatter code for v2
2015-05-23 08:42:17 -05:00
Michael Scherer
85aa984340
Fix error in the column name in the doc
2015-05-15 01:05:38 -04:00
gimoh
5489d172de
Use same interpreter for test-module and module it runs
...
Default python interpreter to the same interpreter the test-module
script is executed with. This is so that the interpreter doesn't have
to be specified twice in the command when using non-default python
(e.g. ``/path/to/python ./hacking/test-module -I python=/path/to/python ...``)
2015-05-06 11:57:25 +01:00
Toshio Kuratomi
4c8d27f7bb
Make module formatting into links to the other module docs
2015-05-05 13:51:22 -07:00
Matt Martz
104b2036f7
egg_info is now written directly to lib
2015-03-27 12:03:20 -05:00
Brian Coca
b6ec502983
added missing element to make google groups link a actual link
2015-03-24 21:09:45 -04:00
Ján Dzurek
cf6155f1c2
rst.j2 template better core module source wording
2015-03-24 20:00:51 +01:00
Brian Coca
c3076b8478
added module returnval documentation to web docs
2015-03-20 16:55:03 -04:00
Brian Coca
2cacac4b23
minor adjustments to formatting
2015-03-20 16:55:03 -04:00
Brian Coca
94909bd4a2
Added return values documentation to modules
2015-03-20 16:55:03 -04:00
Toshio Kuratomi
caf2a96ef9
Merge pdksh fix to v2
2015-03-15 13:22:07 -07:00
Patrik Lundin
731b268cd6
env-setup: Don't use ${.sh.file} if shell is pdksh
...
The default ksh in OpenBSD throws the following error:
===
$ . hacking/env-setup
ksh: hacking/env-setup[23]: ${.sh.file}": bad substitution
[...]
===
The same error can be seen on Linux if pdksh is used.
2015-03-15 10:46:21 +01:00
bmoar
1eaa9d4a08
fix path in Test-module example
2015-03-05 20:30:00 -05:00
Brian Coca
68a06e542d
Merge pull request #9666 from follower/patch-8
...
Correct typo of "actively" (Attempt #2 )
2015-02-26 23:05:28 -05:00
Brian Coca
ee08448b2e
now module_formatter handles new expanded return values from the module_docs (still does not thing with new return value docs)
2015-02-19 18:07:05 -05:00
Alexey Shamrin
b950a38e30
fix links to ansible-devel in documentation pages
2015-02-17 14:30:31 +03:00
Toshio Kuratomi
7c86db3187
Add KSH compat
...
cherry picked from https://github.com/ansible/ansible/pull/6899
2015-02-09 15:37:35 -08:00
ZhiFeng Hu
e63c03d60f
Move update.sh to hacking repository ,see #10081
2015-01-30 14:19:47 +08:00
rpe-github
0a73067153
Use basename -- $0 in case $0 starts with a dash.
...
For example, pdksh $0 contains '-ksh'.
2015-01-25 23:13:54 +01:00
Marco Ippolito
23da2f6415
Redundant file descriptor specifier
2015-01-19 09:03:15 -08:00
Marco Ippolito
4cd5be396d
BUG! Incorrect order of redirection AND incorrect redirection syntax
...
The replaced code only created a text file called `1' in the
current directory, it did *not* redirect output.
2015-01-19 09:03:15 -08:00
Marco Ippolito
bc0f0f838e
More elegant output using here-document syntax
...
POSIX section 2.7.4 defines here-documents.
2015-01-19 09:03:15 -08:00
Marco Ippolito
7eb278e797
Identified two verbosity levels: info, silent
...
Conflicts:
hacking/env-setup
2015-01-19 09:03:15 -08:00
Marco Ippolito
9bc1e1a4a0
Reserve capitalised identifiers for system variables
...
Conflicts:
hacking/env-setup
2015-01-19 09:03:15 -08:00
Marco Ippolito
53fadd371b
No need to prepend `.' to a relative path
2015-01-19 09:03:14 -08:00
Toshio Kuratomi
566a8d1b9d
Fix issue with mixing quoting and glo9bbing.
2015-01-18 10:29:07 -08:00
Toshio Kuratomi
365af69c3e
More quotes and reimplement without pushd/popd
2015-01-18 08:17:37 -08:00
Toshio Kuratomi
dde32a826f
Set default values for shell variables that we use
...
Fixes #9991
2015-01-15 11:08:00 -08:00
Toshio Kuratomi
09e556e9a4
Get rid of bash compound command to make more portable
2015-01-13 11:38:06 -08:00
Toshio Kuratomi
245f934629
Remove shebang and execute perms for env-setup since it must be sourced
2015-01-12 08:03:53 -08:00
Marco Ippolito
b688570380
Corrected quoting of parameter expansions in hacking/env-setup
...
Conflicts:
hacking/env-setup
2015-01-10 17:29:56 -08:00
Marco Ippolito
b8921706f8
Prefer modern-style Bash command substitution in hacking/env-setup
...
Conflicts:
hacking/env-setup
2015-01-10 17:26:19 -08:00
Marco Ippolito
31c8523371
Updated shebang from #!/bin/bash to #!/usr/bin/env bash (more flexible)
2015-01-10 17:21:43 -08:00
Brian Coca
88443d6dcf
Merge pull request #7306 from abadger/feature/egg-info
...
Feature/egg info
2014-12-15 16:26:37 -05:00
Veres Lajos
bf5d8ee678
typofixes - https://github.com/vlajos/misspell_fixer
2014-12-04 22:23:35 +00:00
follower
8b278fee51
Correct typo of "actively" (Attempt #2 )
2014-11-29 18:29:09 +13:00
follower
a1c5294882
Fix misspelled "necessarily"
2014-11-29 14:55:25 +13:00
Brian Coca
339d1ccc8b
fixed issue with subclasses across the repos clobbering each other, they
...
now merge
2014-11-04 20:54:55 -05:00
Brian Coca
2ba5c3c66b
added blank line before section to avoid sphinx warnings
2014-11-04 18:14:30 -05:00
Michael DeHaan
c551fe8b50
Clarify module list footer.
2014-11-04 17:38:02 -05:00
Brian Coca
12393a4b47
subcategories are now Title case and _ gets changed to a space
2014-11-04 08:44:39 -05:00
Brian Coca
5f1ad79cd3
now correctly flags and sorts subcategory modules
2014-11-03 23:14:22 -05:00
Brian Coca
650048f7dd
now displays subcategories correctly
2014-11-03 22:02:13 -05:00
Brian Coca
7bd2c945a7
now doc generation does not ignore subdirs of cloud
2014-11-03 08:15:26 -05:00
Brian Coca
80b1365d53
now correctly processes modules when in subdirs of cloud
2014-11-01 23:19:25 -04:00
Brian Coca
f6d9aa7a8f
corrected text/flag
2014-10-31 16:05:22 -04:00
Brian Coca
023f5fd7e0
Added note explaning the module tagging
2014-10-31 15:06:00 -04:00
Brian Coca
44f0279d0a
Now adds flags for non core and deprecated modules in listing
2014-10-31 14:20:26 -04:00
Brian Coca
86de59235f
bypass core/extras text when module is deprecated
2014-10-31 14:18:18 -04:00
Brian Coca
8b5b97d066
now docs handle deprecated modules but still ignore aliases
2014-10-30 13:29:54 -04:00
Brian Coca
27d741102c
Created Deprecated module category that only appears when there is
...
something to show
2014-10-30 11:26:43 -04:00
Bryan Hunt
e5f651c458
export ANSIBLE_HOME so it can be used in scripts
...
In order that scripts like this can work
```
#!/bin/bash
ansible -vvvv tag_instance_type_foo-training -i "${ANSIBLE_HOME}/plugins/inventory/ec2.py" --private-key=~/Downloads/foo-training.pem -u ec2-user -m ping
```
2014-10-28 20:19:15 +00:00
Brian Coca
5ab4467708
module formatter skips modules with leading underscore to avoid
...
documenting them. Soon will be patched to recognize them as either
deprecated or an alias
2014-10-28 08:36:31 -07:00
Toshio Kuratomi
1e12d3028c
Merge pull request #9384 from insaneirish/devel
...
Change "usuable" to "usable".
2014-10-20 22:08:52 -04:00
insaneirish
3d257bc695
Change "usuable" to "usable".
2014-10-20 10:12:51 -04:00
Igor Vuk
e19f3f8a5c
Typo: greatful -> grateful
2014-10-15 21:08:38 +02:00
Baptiste Mathus
2845f0c455
Typo: recieve -> receive.
2014-10-13 22:10:39 +02:00
Michael DeHaan
2211ae113c
Update rst.j2
...
typo fix
2014-09-29 18:01:16 -04:00
Martin Ueding
dc750e6526
Fix link in reST template
...
There was a missing trailing underscore (`_`) that would have marked the
content in the backticks as a link. This adds it and fixes the link on
every core module page.
2014-09-28 15:27:08 +02:00
Michael DeHaan
ffee9a8fe0
Docsite formatting
2014-09-26 18:23:57 -04:00
Michael DeHaan
7f6ab89b5b
hacking/env-setup no longer needs to set library since modules appear as git submodules.
2014-09-26 17:59:46 -04:00
Michael DeHaan
e8fe306cef
Some various comments about the new repos, more to likely come.
2014-09-26 17:52:50 -04:00
Michael DeHaan
bceb0026a5
Updating the module formatter to deal with the new repo structure.
2014-09-26 17:10:13 -04:00
Michael DeHaan
b818fbb305
Modules are almost always written now by mutliple authors, so don't show this field on website, since it grows obsolete and does not take into account all contributors.
...
Contributors are still listed on github module source and in repo, and original authors still in the file for when development questions arise, but want
to funnel support questions to the mailing list versus directly to them.
2014-09-10 09:42:24 -04:00
Michael Salmon
e827ec702e
Fix issue #8578 . Setting envvar in ""'s ensures the PYTHONPATH is set to
...
include the lib/ directory.
Before - PYTHONPATH is empty.. ansible fails to run
$ source hacking/env-setup.fish
Appending PYTHONPATH
Setting up Ansible to run out of checkout...
PATH=/Volumes/opt/src/ansible/bin /usr/local/share/python3 /usr/local/bin
/usr/bin /bin /usr/sbin /sbin /usr/local/bin /opt/X11/bin /usr/bin /sbin
/usr/local/bin /Users/ms/bin/
PYTHONPATH=
ANSIBLE_LIBRARY=/Volumes/opt/src/ansible/library
...
Traceback (most recent call last):
File "/Volumes/opt/src/ansible/bin/ansible", line 25, in <module>
from ansible.runner import Runner
ImportError: No module named ansible.runner
After change - it's set.. ansible runs.
source hacking/env-setup.fish
Appending PYTHONPATH
Setting up Ansible to run out of checkout...
PATH=/Volumes/opt/src/ansible/bin /usr/local/share/python3 /usr/local/bin
/usr/bin /bin /usr/sbin /sbin /usr/local/bin /opt/X11/bin /usr/bin /sbin
/usr/local/bin /Users/ms/bin/
PYTHONPATH=/Volumes/opt/src/ansible/lib:
ANSIBLE_LIBRARY=/Volumes/opt/src/ansible/library
....
$ ansible
Usage: ansible <host-pattern> [options]
2014-08-12 12:09:20 -07:00
Hector Acosta
b8cbf1370f
Add checkmode support for test-module script
...
Signed-off-by: Hector Acosta <hector.acosta@gmail.com>
2014-07-20 13:54:30 -05:00
Michael DeHaan
dfd4f18095
Docsite things.
2014-06-19 14:25:28 -05:00
Toshio Kuratomi
6a6060ac55
Teach env-setup how to create egg-info for ansible so that pkg_resources works
2014-05-06 11:19:41 -07:00
Felix Kaiser
3b06ab84e3
Make test-module interpret --args='{...' as yaml
2014-04-10 21:14:42 +02:00
Max Riveiro
9f7342d46d
Add tesing deps installation into hacking/README
...
Signed-off-by: Max Riveiro <kavu13@gmail.com>
2014-03-23 00:42:51 +04:00
Cristian Ciupitu
0749112286
Micro-optimization: replace s.find(x)!=-1 with x in s
...
timeit shows a speedup of ~3x on Python 2.7.5 x86_64.
It also makes the code a bit shorter.
2014-03-16 13:10:28 -04:00
Lukáš Lalinský
95d102f5e4
Remove obsolete module development docs
2014-02-22 15:51:59 +01:00
willthames
e2d04f7e96
Allow hacking/env-setup module path to use config file library path
...
hacking/env-setup now adds the configured library path in ANSIBLE_CONFIG
to the ANSIBLE_LIBRARY environment variable in addition to the previous
default of ANSIBLE_HOME/library.
This replaces #5950 .
2014-02-12 12:06:57 +10:00
Matt Martz
dbed05caec
Support for -a to accept a file with test-module
...
If the CLI value for -a starts with an @, treat it like a file, and dump the contents into complex_args
This supports yaml or json.
2014-02-07 13:09:47 -06:00
jctanner
7fa0d8bdd3
Merge pull request #5461 from sivel/test-module-interpreter
...
Add -I/--interpreter argument to test-module
2014-01-29 16:24:37 -08:00
Michael DeHaan
3b8fd62ff9
More site rename things.
2014-01-28 20:29:42 -05:00
Michael DeHaan
c4a8a6d3c2
Add an "all" category so all modules show up uncategorized there.
2014-01-02 17:42:18 -05:00
Michael DeHaan
2f811c40d7
Basic docsite formatting fixups
2014-01-02 17:36:52 -05:00
Matt Martz
e50c2bccb8
Add -I/--interpreter argument to test-module
2013-12-30 14:53:32 -06:00
Mikhail Sobolev
84948292f3
include short_description in the module page's title
2013-12-26 14:35:57 -05:00