ansible/hacking/build_library/build_ansible
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.
2020-06-11 11:03:43 -07:00
..
command_plugins Plugin/module docs: parse return values, add collection names in them (version_added_collection), and format them nicely in ansible-doc (#69796) 2020-06-11 11:03:43 -07:00
jinja2 Galaxy meta docs table (#60171) 2019-08-13 15:00:13 -05:00
__init__.py
announce.py Allow announce script to work for base and older (#69768) 2020-05-29 16:20:30 -05:00
change_detection.py Remove outdated docs and unneeded import from change_detection build file 2020-05-14 09:14:37 -07:00
commands.py Fix the command plugin to use the ABCMeta metaclass 2020-05-14 09:14:37 -07:00
errors.py create-deprecated-issues script can now add to a specified project (#61901) 2019-09-09 17:28:52 -07:00