6 Commits (f5b945bf6a53c8a2b4c900f28d1790818d7b934f)

Author	SHA1	Message	Date
flowerysong	f5b945bf6a	ansible-doc: fix typo in output (#83205)	6 months ago
Brian Coca	bec27fb4c0	prettyfy ansible-doc (#75116) ... * prettify ansibile-doc output delimiters when no color avoid triggering color mode for existing tests all use _format to observe nocolor more v more info imporoved conditional display updated version on -v normalize role errors expand role data, dedupe code, fix formatting on warning fix bug with galaxy info role list improvements: lists all roles (even w/o meta/argspec) specs now indented under role role only listed once Updated tests to reflect format changes Co-authored-by: Felix Fontein <felix@fontein.de>	10 months ago
Felix Fontein	fa093d8adf	ansible-doc: remove manual formatting (#78668) ... * remove manual formatting and make the output align closer with the original YAML Co-authored-by: Brian Coca <brian.coca+git@gmail.com>	2 years ago
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
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.	4 years ago
Felix Fontein	840d3a9dd7	ansible-doc: properly handle suboptions (#69795) ... * Specifically handle suboptions, contains, etc in ansible-doc.	4 years ago