Skip to content

Fix docs build #2617

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 8, 2025
Merged

Fix docs build #2617

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
24587f6
Document PluginInfo.
felixfontein May 7, 2025
d80a29a
Move PluginInfo before Argument Spec, and fix heading underlines.
felixfontein May 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions docs/docsite/rst/reference_appendices/module_utils.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Ansible modules in Python.


AnsibleModule
--------------
=============

To use this functionality, include ``from ansible.module_utils.basic import AnsibleModule`` in your module.

Expand All @@ -19,35 +19,43 @@ 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.

.. automodule:: ansible.module_utils.basic
: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:
:member-order: bysource
: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:
Expand All @@ -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.

Expand All @@ -67,7 +75,7 @@ Standalone functions for validating various parameter types.


Errors
------
======

.. automodule:: ansible.module_utils.errors
:members:
Expand Down