ansible

Commit Graph

Author	SHA1	Message	Date
Brian Coca	4260b71cc7	refactor and fixes for doc parsing (#77719 ) * refactor and remove redundant code in documentation allow location and building api to be more accessible fix issues with displaying ansible.legacy and ansible.builtin ensure we don't x2 process tokens (some modules reference them also) fixes #77764 move to constants vs hardcoded more informative errors and comments now have actual filter/test plugins, which expose the filter/test functions moved filter/test loading/finding logic into jinja2pluginloader, removed dupe implementations added tests for case in which we unique by basename when listing Update lib/ansible/utils/plugin_docs.py Co-authored-by: Sloane Hertel <19572925+s-hertel@users.noreply.github.com>	2 years ago
Sloane Hertel	5b03267a1f	Add ansible-doc tests for documentation containing YAML anchors (#70436 ) Co-authored-by: Tadej Borovšak <tadej.borovsak@xlab.si>	4 years ago
Felix Fontein	9164b96774	ansible-doc man formatter: fail with better error message when description isn't there (#70046 ) * ansible-doc man formatter: do not crash when description isn't there. * Change to report a better error message when description is not there. * Add test.	4 years ago
Felix Fontein	8d93ba9120	Plugin/module docs: parse return values, add collection names in them (version_added_collection), and format them nicely in ansible-doc (#69796 ) * Tag return value docs if they are a dict (and not str/None). * Try to parse return docs as YAML. * Properly dump return values in ansible-doc. * Adjust plugin formatter. * Add changelog fragment. * Don't add 'default' for return values. * Fix plugin_formatter. * Only try to parse return docs if they are still a string. * Add tests. * Warn if RETURN cannot be parsed. * Adjust tests. Also test for warning. * if -> elif (otherwise EXAMPLE will be parsed too). * Always parse return documentation, and fail if it is invalid YAML. * Polishing. * Mostly re-enable ansible-doc tests. Listing from the local collection seems to be somewhat broken. I assume this is why the test was disabled. * Lint and make tests work with Python 2. * Keep FQCNs in plugins (not modules), i.e. restore previous state.	5 years ago
Nilashish Chakraborty	9d6b0f2b03	Support `removed_at_date` in ansible-doc (#70002 ) * Support removed_at_date in ansible-doc Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com> Changes: * ansible-doc does not support `removed_at_date` and assumes that deprecated dict will either have `removed_in` or `version`. This results in ansible-doc (and hence "sanity --test=ansible-doc") failing for modules having only `removed_at_date`. * This patch adds support for `removed_at_date` and also gives it precedence over `removed_in` or `version`. * Add tests and changelog Signed-off-by: NilashishC <nilashishchakraborty8@gmail.com>	5 years ago
Felix Fontein	840d3a9dd7	ansible-doc: properly handle suboptions (#69795 ) * Specifically handle suboptions, contains, etc in ansible-doc.	5 years ago
Matt Martz	0e46af17a5	Nuke all removed_module stubs (#67139 ) * Nuke all removed_module stubs * Remove ignores and botmeta entry	5 years ago
Matt Clay	3b86dc3e12	WIP - Fix ansible-doc bugs and add integration tests. (#62461 ) * Add integration tests for ansible-doc. * Enable tests that now pass * Cleanup processing of plugin docs * Mostly separate the steps of processing plugin docs 1) Acquire source data 2) Transform and calculate additonal data 3) Format data for output 4) Output data format_plugin_doc() is still mixing transformation and formatting but that should be fixed in a devel-only change * Raise exceptions in _get_plugin_doc() on errors. * Remove check to exclude on blacklisted extensions. We already request only .py files * If there is no DOCUMENTATION entry in the plugin, raise an exception from _get_plugin_doc(). Everywhere we use _get_plugin_doc(), this is treated as an error * If there is no ANSIBLE_METADATA raise an exception as well as displaying of docs assumes that this has been set. * If there is neither DOCUMENTATION nor ANSIBLE_METADATA, warn about the lack of METADATA and error on the lack of DOCUMENTATION. Lack of DOCUMENTATION is more important so it is what the user should see. * Add a few special cases for backwards compat. These should probably be made errors in 2.10: * no docs but has metadata shows no documentation rather than an error * empty plugin file shows no doumentation rather than an error * Simplify backwards compatibility logic.	5 years ago

8 Commits (5dc3a2ee6d2c1110b17259c6a5f5f82108df7581)