Brian Coca
1e818f9c50
ansible-doc now shows return value docs
2015-02-19 13:18:05 -05:00
Dagobert Michelsen
84718156e3
Use termios instead of stty for compatibility
2015-02-06 13:43:47 +01:00
rpe-github
3e7bb0c081
ignore VERSION file in ansible-doc
2015-01-22 19:46:10 +01:00
Michael Scherer
caefc20f16
Use --version to see if less can be executed
...
(less) 2> /dev/null would fail if stdin is /dev/null.
Sinceless --version do not read anything from stdin,
it is perfect for seeing if the software exist or not.
Also replace the whole os system detection by directly
using subprocess ( as we use it elsewhere, we already
depend on it ).
2014-12-14 18:09:42 +01:00
Michael Scherer
f7ac012301
Do not assume that stdin is a tty
...
This can be used from another non interactive software, see #9695
for details.
2014-12-14 17:56:18 +01:00
Brian Coca
7a5e7db2df
ansible doc now finds modules recursively
...
more intelligent about ignoring files that are clearly not modules
2014-11-01 01:17:42 -04:00
Brian Coca
0317e7b910
avoid modifying module var by just passing the substring to the append
2014-10-30 13:53:05 -04:00
Brian Coca
94a732fb1a
fixed typo in comments
2014-10-30 13:50:34 -04:00
Brian Coca
0fb0548d0b
removed no unused var that was not cleaned up properlly
2014-10-30 13:40:34 -04:00
Brian Coca
e41bcc41d3
removed 'column display' options as there is no code handling this
...
function
2014-10-30 08:56:41 -04:00
Brian Coca
1b70ef6cba
Several changes to ansible-doc
...
added display of deprecated to ansible-doc
now it does better job of using tty columns
fixed indication truncation of desc with trailing ...
removed extension from module list, also fixed matching exlusion
blacklist
2014-10-29 22:33:31 -04:00
Brian Coca
b3b356480d
added the ability to keep aliased and deprecated modules prefixed with
...
'_', they will be loaded after non prefixed modules are checked they can
be full modules or symlinks to existing ones (alias)
also updated ansible doc to ignore these, will eventually add selective
display
2014-10-27 15:54:41 -07:00
Ton Kersten
39bbe36fc7
Ignore compiled Python for documentation.
...
When running `ansible-doc --list` a lot of errors are
generated when `ansible-doc` tries to find documentation
strings in `.pyc` files.
2014-10-26 15:46:08 +01:00
Michael DeHaan
b0295af7ee
Merge pull request #7462 from chamill/devel
...
Add spaces between sentences in formatted docs.
2014-08-11 15:53:16 -04:00
Michael DeHaan
5a2fd5c612
Ignore powershell implementation files with ansible-doc as documentation lives in Python stubs.
2014-07-28 12:13:30 -04:00
C. Morgan Hamill
43b72f2a80
Add spaces between sentences in formatted docs.
...
Increases readability when using `ansible-doc`.
2014-07-17 09:10:42 -04:00
Michael Leer
37318ca095
include default options. #7938
...
amend ansible-doc to include default options as per feature request #7938
2014-07-01 18:05:18 +01:00
Stefhen Hovland
e1b7278265
Only display equals sign in summary for required options.
2014-02-14 00:12:29 -05:00
Stefhen Hovland
30cabddf76
Ensure option output is sorted.
2014-02-14 00:11:21 -05:00
James Tanner
91e5569324
Merge pull request #4466 from sfromm/ansible
...
Add pager support to ansible-doc
2013-11-13 20:32:20 -05:00
Stoned Elipot
c7217a8f1b
Fix 'ansible-doc -l' runtime error following commit 4430d0f
...
skip "module" not found as plugin, id est directory
2013-10-16 21:58:54 +02:00
Stephen Fromm
79d6d344d8
Add pager support to ansible-doc
...
If PAGER is set, or the executable less is present, ansible-doc will use
it to pipe information into so that it can be scrolled through.
If the environment variable LESS is not set, this will set it to FRSX.
2013-10-11 10:21:29 -07:00
Stoned Elipot
d25888f410
Fix empty requirements specifications in modules documentation
...
And also be liberal in what ansible-doc accepts as an empty
requirements specification.
While here fix a typo in template module documentation
wrt jinja2 overrides example.
2013-05-16 17:15:21 +02:00
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
2013-05-11 16:46:59 +02:00
Jan-Piet Mens
2f76bc9e47
ansible-doc: skip directories (new library/ format)
2013-04-30 08:31:39 +02:00
Michael DeHaan
e6bf01a6b0
Make plugin loader path operations more efficient.
2013-04-20 12:31:14 -04:00
Jan-Piet Mens
396a07bcc7
Add support for additional EXAMPLES string in Ansible modules
...
return DOC and EXAMPLES as a list
add moduledev explanation
more
2013-02-18 20:02:46 +01:00
Michael DeHaan
c4779d95b8
Removing unused import, 'make pyflakes' is now clean.
2013-02-17 19:49:50 -05:00
Michael DeHaan
5c38248788
Fix crontab doc formatting
2013-02-09 14:29:31 -05:00
Michael DeHaan
25f52d79d1
Tweak sysctl docs so they'll web-render
2013-01-26 12:58:12 -05:00
Michael DeHaan
36066d8664
Fixup ec2_facts docs parsing
2013-01-26 12:34:30 -05:00
Jan-Piet Mens
52a55a3575
cleanup Example output in ansible-doc
2012-12-14 11:12:26 +01:00
Jan-Piet Mens
e913fb8732
print Notes heading only if there are any
2012-12-11 08:26:12 +01:00
Jan-Piet Mens
77e060250c
CLI: ansible-doc rebased
2012-12-03 09:01:04 +01:00
Jan-Piet Mens
17f31a2a79
CLI: ansible-doc shows lists of modules & module docs on command-line
...
check path is directory
added manpage & setup
small cleanup
shut up module_formatter in utils to avoid trace print on crud files in library
2012-11-30 21:57:25 -05:00
