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/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
5 years ago
..
.rstcheck.cfg Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416) 7 years ago
YAMLSyntax.rst Update YAMLSyntax.rst with yamllint (#66622) 6 years ago
automationhub.rst add Automation Hub stub page (#65261) 6 years ago
common_return_values.rst update the definition of changed (#71865) 5 years ago
faq.rst Rebased pr73824 (#73934) 5 years ago
general_precedence.rst Fixing ad-hoc commands #73636 (#73646) 5 years ago
glossary.rst Rebased pr73824 (#73934) 5 years ago
interpreter_discovery.rst Docsite: replace Latin phrases to English (#71588) 5 years ago
logging.rst Docs: User guide overhaul, part 1 (#63056) 6 years ago
module_utils.rst Add porting guide and documentation for changes to argument spec validation (#74268) 5 years ago
python_3_support.rst Clarify Python 2.x support in python_3_support.rst (#64077) 6 years ago
release_and_maintenance.rst Rebased pr73824 (#73934) 5 years ago
special_variables.rst doc: fix ansible_play_hosts description about failure (#73190) 5 years ago
test_strategies.rst Minor typo in test_strategies.rst (#72060) 5 years ago
tower.rst docs/docsite/rst/: fix typos (#67645) 6 years ago