Commit Graph

37 Commits (4d3aa721439f98ff4a41579878e87aeb5eaf97f2)

Author SHA1 Message Date
James Cammarata ce3ef7f4c1 Making the switch to v2 10 years ago
Brian Coca 4805fa6b0b fix ansible-doc listing with new docstring
fixes #10295
10 years ago
Brian Coca 1e818f9c50 ansible-doc now shows return value docs 10 years ago
Dagobert Michelsen 84718156e3 Use termios instead of stty for compatibility 10 years ago
rpe-github 3e7bb0c081 ignore VERSION file in ansible-doc 10 years ago
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 ).
10 years ago
Michael Scherer f7ac012301 Do not assume that stdin is a tty
This can be used from another non interactive software, see #9695
for details.
10 years ago
Brian Coca 7a5e7db2df ansible doc now finds modules recursively
more intelligent about ignoring files that are clearly not modules
10 years ago
Brian Coca 0317e7b910 avoid modifying module var by just passing the substring to the append 10 years ago
Brian Coca 94a732fb1a fixed typo in comments 10 years ago
Brian Coca 0fb0548d0b removed no unused var that was not cleaned up properlly 10 years ago
Brian Coca e41bcc41d3 removed 'column display' options as there is no code handling this
function
10 years ago
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
10 years ago
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
10 years ago
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.
10 years ago
Michael DeHaan b0295af7ee Merge pull request #7462 from chamill/devel
Add spaces between sentences in formatted docs.
10 years ago
Michael DeHaan 5a2fd5c612 Ignore powershell implementation files with ansible-doc as documentation lives in Python stubs. 10 years ago
C. Morgan Hamill 43b72f2a80 Add spaces between sentences in formatted docs.
Increases readability when using `ansible-doc`.
10 years ago
Michael Leer 37318ca095 include default options. #7938
amend ansible-doc to include default options as per feature request #7938
11 years ago
Stefhen Hovland e1b7278265 Only display equals sign in summary for required options. 11 years ago
Stefhen Hovland 30cabddf76 Ensure option output is sorted. 11 years ago
James Tanner 91e5569324 Merge pull request #4466 from sfromm/ansible
Add pager support to ansible-doc
11 years ago
Stoned Elipot c7217a8f1b Fix 'ansible-doc -l' runtime error following commit 4430d0f
skip "module" not found as plugin, id est directory
11 years ago
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.
11 years ago
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.
12 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
12 years ago
Jan-Piet Mens 2f76bc9e47 ansible-doc: skip directories (new library/ format) 12 years ago
Michael DeHaan e6bf01a6b0 Make plugin loader path operations more efficient. 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 c4779d95b8 Removing unused import, 'make pyflakes' is now clean. 12 years ago
Michael DeHaan 5c38248788 Fix crontab doc formatting 12 years ago
Michael DeHaan 25f52d79d1 Tweak sysctl docs so they'll web-render 12 years ago
Michael DeHaan 36066d8664 Fixup ec2_facts docs parsing 12 years ago
Jan-Piet Mens 52a55a3575 cleanup Example output in ansible-doc 12 years ago
Jan-Piet Mens e913fb8732 print Notes heading only if there are any 12 years ago
Jan-Piet Mens 77e060250c CLI: ansible-doc rebased 12 years ago
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
12 years ago