You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/hacking/build_library/build_ansible/command_plugins
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
..
collection_meta.py Turn pathlib paths into strs 5 years ago
dump_config.py Turn pathlib paths into strs 5 years ago
dump_keywords.py Docs scripts cleanup (#59169) 5 years ago
file_deprecated_issues.py create-deprecated-issues script can now add to a specified project (#61901) 5 years ago
generate_man.py Move common build code from _build_helpers (#55986) 5 years ago
plugin_formatter.py Plugin/module docs: parse return values, add collection names in them (version_added_collection), and format them nicely in ansible-doc (#69796) 5 years ago
porting_guide.py Remove unused imports in the porting_guide command plugin 5 years ago
release_announcement.py Move common build code from _build_helpers (#55986) 5 years ago
update_intersphinx.py Add a script to update the intersphinx inventory (#66646) 5 years ago