centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-26 13:18:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

Fix docs build (#2617)

Browse Source 
* Document PluginInfo.

* Move PluginInfo before Argument Spec, and fix heading underlines.
This commit is contained in:
Felix Fontein
2025-05-08 21:58:04 +02:00
committed by GitHub
parent f94a97b794
commit 2bb139cbdc
1 changed files with 16 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/docsite/rst/reference_appendices/module_utils.rst
View File

@@ -10,7 +10,7 @@ Ansible modules in Python.
AnsibleModule
--------------
=============
To use this functionality, include ``from ansible.module_utils.basic import AnsibleModule`` in your module.
@@ -19,7 +19,7 @@ To use this functionality, include ``from ansible.module_utils.basic import Ansi
:noindex:
Basic
------
=====
To use this functionality, include ``import ansible.module_utils.basic`` in your module.
@@ -27,19 +27,27 @@ To use this functionality, include ``import ansible.module_utils.basic`` in your
:members:
PluginInfo
==========
To use this functionality, include ``from ansible.module_utils.common.messages import PluginInfo`` in your module.
.. autoclass:: ansible.module_utils.common.messages.PluginInfo
:members:
Argument Spec
---------------------
=============
Classes and functions for validating parameters against an argument spec.
ArgumentSpecValidator
=====================
---------------------
.. autoclass:: ansible.module_utils.common.arg_spec.ArgumentSpecValidator
:members:
ValidationResult
================
----------------
.. autoclass:: ansible.module_utils.common.arg_spec.ValidationResult
:members:
@@ -47,7 +55,7 @@ ValidationResult
:private-members: _no_log_values # This only works in sphinx >= 3.2. Otherwise it shows all private members with doc strings.
Parameters
==========
----------
.. automodule:: ansible.module_utils.common.parameters
:members:
@@ -58,7 +66,7 @@ Parameters
used to check that type, :func:`~ansible.module_utils.common.validation.check_type_str` in this case.
Validation
==========
----------
Standalone functions for validating various parameter types.
@@ -67,7 +75,7 @@ Standalone functions for validating various parameter types.
Errors
------
======
.. automodule:: ansible.module_utils.errors
:members: