Skip to content

Commit 2bb139c

Browse files
authored
Fix docs build (#2617)
* Document PluginInfo. * Move PluginInfo before Argument Spec, and fix heading underlines.
1 parent f94a97b commit 2bb139c

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

docs/docsite/rst/reference_appendices/module_utils.rst

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Ansible modules in Python.
1010

1111

1212
AnsibleModule
13-
--------------
13+
=============
1414

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

@@ -19,35 +19,43 @@ To use this functionality, include ``from ansible.module_utils.basic import Ansi
1919
:noindex:
2020

2121
Basic
22-
------
22+
=====
2323

2424
To use this functionality, include ``import ansible.module_utils.basic`` in your module.
2525

2626
.. automodule:: ansible.module_utils.basic
2727
:members:
2828

2929

30+
PluginInfo
31+
==========
32+
33+
To use this functionality, include ``from ansible.module_utils.common.messages import PluginInfo`` in your module.
34+
35+
.. autoclass:: ansible.module_utils.common.messages.PluginInfo
36+
:members:
37+
3038
Argument Spec
31-
---------------------
39+
=============
3240

3341
Classes and functions for validating parameters against an argument spec.
3442

3543
ArgumentSpecValidator
36-
=====================
44+
---------------------
3745

3846
.. autoclass:: ansible.module_utils.common.arg_spec.ArgumentSpecValidator
3947
:members:
4048

4149
ValidationResult
42-
================
50+
----------------
4351

4452
.. autoclass:: ansible.module_utils.common.arg_spec.ValidationResult
4553
:members:
4654
:member-order: bysource
4755
:private-members: _no_log_values # This only works in sphinx >= 3.2. Otherwise it shows all private members with doc strings.
4856

4957
Parameters
50-
==========
58+
----------
5159

5260
.. automodule:: ansible.module_utils.common.parameters
5361
:members:
@@ -58,7 +66,7 @@ Parameters
5866
used to check that type, :func:`~ansible.module_utils.common.validation.check_type_str` in this case.
5967

6068
Validation
61-
==========
69+
----------
6270

6371
Standalone functions for validating various parameter types.
6472

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

6876

6977
Errors
70-
------
78+
======
7179

7280
.. automodule:: ansible.module_utils.errors
7381
:members:

0 commit comments

Comments
 (0)