ansible/docs/docsite/rst
Sam Doran 2cbfd1e350
Add porting guide and documentation for changes to argument spec validation (#74268)
* Add ArgumentSpecValidator to docs
* Improve docs for ArgumentSpecValidator
* Document removal of private methods

* Update module_utils documentation
    - Add docs for argument spec classes as well as validation and parameters files.
    - preserve the order in the source for errors.py
    - document DEFAULT_TYPE_VALIDATORS so it can be referenced elsewhere
    - fix automodule directive for validation.py

* Update docs in arg_spec and paremeters
    - This improves the generated documentation.

* Document breaking changes in porting guide.
* Update formatting in porting guide and add a Deprecated section
* Fine tune module_utils documentation


* Move instance docstring to the __init__ method
  Remove optional description since it fails the sanity test and I am not 100% it is valid anyway.

* Remoe incorrect parameter from docstring
  This was changed a while ago but wasn't removed from the docstring.

* Use attr rather than attribute
  The py:attribute: domain only exists in newer Sphinx >= 3.1.

* Improve documentation on exceptions
* Final pass
    - use args/kwargs instead of param
    - fix formatting errors that didn't display examples correctly
    - format TypeErrors so they are referenced as classes
    - specify complex types
2021-04-20 15:40:53 -04:00
..
api remove build errors including guess (#69711) 2020-05-29 11:56:49 -05:00
collections Add link to all module and plugin indexes (#72743) 2020-12-18 11:55:31 -05:00
community Updating Community docs with DO information (#74019) 2021-03-24 16:24:46 -04:00
dev_guide remove deprecated ansible.module_utils._text from documentation (#73211) 2021-04-20 11:53:27 -04:00
galaxy Rebased pr73824 (#73934) 2021-03-17 16:07:38 -04:00
images Adds custom 404 with cowsay image (#57422) 2019-06-17 10:47:54 -05:00
installation_guide Update version on FreeBSD (#73664) 2021-03-25 16:30:52 -04:00
inventory Add implicit localhost hostvars note (#61956) 2019-09-16 14:00:29 -04:00
network Remove include from tests (#74330) 2021-04-20 11:19:29 -04:00
plugins Update lookup.rst (#73716) 2021-04-20 12:54:54 -05:00
porting_guides Add porting guide and documentation for changes to argument spec validation (#74268) 2021-04-20 15:40:53 -04:00
reference_appendices Add porting guide and documentation for changes to argument spec validation (#74268) 2021-04-20 15:40:53 -04:00
roadmap Add 2.12 roadmap (#74000) 2021-04-06 12:43:38 -05:00
scenario_guides vmware: Add a note about known issue (#73273) 2021-04-20 14:11:45 -04:00
shared_snippets Fixing ad-hoc commands #73636 (#73646) 2021-02-18 16:48:22 -06:00
user_guide Docs: Fix k8s_config_resource_name YAML example (#74129) 2021-04-20 13:37:44 -04:00
2.10_index.rst Split Ansible docs from core docs (#73616) 2021-02-17 09:57:05 -06:00
404.rst removes link from 404 content, explains options (#57971) 2019-06-18 09:25:12 -04:00
ansible_index.rst Split Ansible docs from core docs (#73616) 2021-02-17 09:57:05 -06:00
core_index.rst Add 2.12 roadmap (#74000) 2021-04-06 12:43:38 -05:00