ansible/docs/docsite/rst/reference_appendices
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
..
.rstcheck.cfg Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 2018-12-10 09:17:15 -06:00
automationhub.rst add Automation Hub stub page (#65261) 2019-11-25 13:58:01 -06:00
common_return_values.rst update the definition of changed (#71865) 2020-09-24 14:33:22 -05:00
faq.rst Rebased pr73824 (#73934) 2021-03-17 16:07:38 -04:00
general_precedence.rst Fixing ad-hoc commands #73636 (#73646) 2021-02-18 16:48:22 -06:00
glossary.rst Rebased pr73824 (#73934) 2021-03-17 16:07:38 -04:00
interpreter_discovery.rst Docsite: replace Latin phrases to English (#71588) 2020-09-03 14:47:57 -05:00
logging.rst Docs: User guide overhaul, part 1 (#63056) 2019-10-08 13:46:38 -04:00
module_utils.rst Add porting guide and documentation for changes to argument spec validation (#74268) 2021-04-20 15:40:53 -04:00
python_3_support.rst Clarify Python 2.x support in python_3_support.rst (#64077) 2019-11-05 16:08:07 -05:00
release_and_maintenance.rst Rebased pr73824 (#73934) 2021-03-17 16:07:38 -04:00
special_variables.rst doc: fix ansible_play_hosts description about failure (#73190) 2021-01-18 15:24:29 -05:00
test_strategies.rst Minor typo in test_strategies.rst (#72060) 2020-10-01 14:34:23 -04:00
tower.rst docs/docsite/rst/: fix typos (#67645) 2020-02-21 10:57:07 +00:00
YAMLSyntax.rst Update YAMLSyntax.rst with yamllint (#66622) 2020-02-14 12:18:13 -05:00