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
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
Mikhail Sobolev
fce90e0370
use rst formatting for sphinx part
2013-12-25 21:20:11 +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
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
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
.
2013-12-04 14:36:47 +01:00
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.
2013-11-27 21:34:00 -05:00
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)
2013-11-27 21:14:38 -05:00
phy1729
2b3381de7c
Add zsh support for working dir independant sourcing
2013-11-19 13:35:01 -06: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
jctanner
b6c1574f5c
Merge pull request #4765 from mvo5/bugfix/fix-man-template
...
Fixes in the man template
2013-11-06 08:20:27 -08:00
Michael Vogt
b8e641136a
make comment lines in troff start with .\" and add a .SH EXAMPLES to the PLAINEXAMPLES section
2013-11-01 09:20:05 +01:00