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
Sam Doran 2743ea1e69
[stable-2.11] Add porting guide and documentation for changes to argument spec validation (#74268) (#74353)
* 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.

* Remove 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
(cherry picked from commit 2cbfd1e350)

Co-authored-by: Sam Doran <sdoran@redhat.com>
5 years ago
..
api remove build errors including guess (#69711) 6 years ago
collections Add link to all module and plugin indexes (#72743) 5 years ago
community Backport/2.11/docs2 (#74484) 5 years ago
dev_guide Backport/2.11/docs2 (#74484) 5 years ago
galaxy Rebased pr73824 (#73934) 5 years ago
images Adds custom 404 with cowsay image (#57422) 7 years ago
installation_guide Backport/2.11/docs2 (#74484) 5 years ago
inventory Add implicit localhost hostvars note (#61956) 6 years ago
network Backport/2.11/docs2 (#74484) 5 years ago
plugins Backport/2.11/docs1 (#74457) 5 years ago
porting_guides [stable-2.11] Add porting guide and documentation for changes to argument spec validation (#74268) (#74353) 5 years ago
reference_appendices [stable-2.11] Add porting guide and documentation for changes to argument spec validation (#74268) (#74353) 5 years ago
roadmap Updated COLLECTIONS_4.rst to include ansible-inclusion repo link for new collection submission (#73582) 5 years ago
scenario_guides Backport/2.11/docs2 (#74484) 5 years ago
shared_snippets Fixing ad-hoc commands #73636 (#73646) 5 years ago
user_guide Backport/2.11/docs2 (#74484) 5 years ago
2.10_index.rst Split Ansible docs from core docs (#73616) 5 years ago
404.rst removes link from 404 content, explains options (#57971) 7 years ago
ansible_index.rst Split Ansible docs from core docs (#73616) 5 years ago
core_index.rst describe what ansible-core is (#73829) 5 years ago