summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--.github/BOTMETA.yml40
-rw-r--r--docs/docsite/rst/dev_guide/developing_modules_documenting.rst9
-rw-r--r--docs/docsite/rst/dev_guide/developing_modules_in_groups.rst6
-rw-r--r--lib/ansible/config/base.yml8
-rw-r--r--lib/ansible/plugins/doc_fragments/__init__.py (renamed from lib/ansible/utils/module_docs_fragments/__init__.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/a10.py (renamed from lib/ansible/utils/module_docs_fragments/a10.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/aci.py (renamed from lib/ansible/utils/module_docs_fragments/aci.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/acme.py (renamed from lib/ansible/utils/module_docs_fragments/acme.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/aireos.py (renamed from lib/ansible/utils/module_docs_fragments/aireos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/alicloud.py (renamed from lib/ansible/utils/module_docs_fragments/alicloud.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/aruba.py (renamed from lib/ansible/utils/module_docs_fragments/aruba.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/asa.py (renamed from lib/ansible/utils/module_docs_fragments/asa.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/auth_basic.py (renamed from lib/ansible/utils/module_docs_fragments/auth_basic.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/avi.py (renamed from lib/ansible/utils/module_docs_fragments/avi.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/aws.py (renamed from lib/ansible/utils/module_docs_fragments/aws.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/aws_credentials.py (renamed from lib/ansible/utils/module_docs_fragments/aws_credentials.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/azure.py (renamed from lib/ansible/utils/module_docs_fragments/azure.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/azure_tags.py (renamed from lib/ansible/utils/module_docs_fragments/azure_tags.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/backup.py (renamed from lib/ansible/utils/module_docs_fragments/backup.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ce.py (renamed from lib/ansible/utils/module_docs_fragments/ce.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/cloudstack.py (renamed from lib/ansible/utils/module_docs_fragments/cloudstack.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/cnos.py (renamed from lib/ansible/utils/module_docs_fragments/cnos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/constructed.py (renamed from lib/ansible/utils/module_docs_fragments/constructed.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/decrypt.py (renamed from lib/ansible/utils/module_docs_fragments/decrypt.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/default_callback.py (renamed from lib/ansible/utils/module_docs_fragments/default_callback.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/dellos10.py (renamed from lib/ansible/utils/module_docs_fragments/dellos10.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/dellos6.py (renamed from lib/ansible/utils/module_docs_fragments/dellos6.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/dellos9.py (renamed from lib/ansible/utils/module_docs_fragments/dellos9.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/digital_ocean.py (renamed from lib/ansible/utils/module_docs_fragments/digital_ocean.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/dimensiondata.py (renamed from lib/ansible/utils/module_docs_fragments/dimensiondata.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/dimensiondata_wait.py (renamed from lib/ansible/utils/module_docs_fragments/dimensiondata_wait.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/docker.py (renamed from lib/ansible/utils/module_docs_fragments/docker.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ec2.py (renamed from lib/ansible/utils/module_docs_fragments/ec2.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/emc.py (renamed from lib/ansible/utils/module_docs_fragments/emc.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/enos.py (renamed from lib/ansible/utils/module_docs_fragments/enos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/eos.py (renamed from lib/ansible/utils/module_docs_fragments/eos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/exoscale.py (renamed from lib/ansible/utils/module_docs_fragments/exoscale.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/f5.py (renamed from lib/ansible/utils/module_docs_fragments/f5.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/files.py (renamed from lib/ansible/utils/module_docs_fragments/files.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/fortios.py (renamed from lib/ansible/utils/module_docs_fragments/fortios.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/gcp.py (renamed from lib/ansible/utils/module_docs_fragments/gcp.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ibm_storage.py (renamed from lib/ansible/utils/module_docs_fragments/ibm_storage.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/infinibox.py (renamed from lib/ansible/utils/module_docs_fragments/infinibox.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/influxdb.py (renamed from lib/ansible/utils/module_docs_fragments/influxdb.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ingate.py (renamed from lib/ansible/utils/module_docs_fragments/ingate.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/inventory_cache.py (renamed from lib/ansible/utils/module_docs_fragments/inventory_cache.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ios.py (renamed from lib/ansible/utils/module_docs_fragments/ios.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/iosxr.py (renamed from lib/ansible/utils/module_docs_fragments/iosxr.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ipa.py (renamed from lib/ansible/utils/module_docs_fragments/ipa.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ironware.py (renamed from lib/ansible/utils/module_docs_fragments/ironware.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/junos.py (renamed from lib/ansible/utils/module_docs_fragments/junos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/k8s_auth_options.py (renamed from lib/ansible/utils/module_docs_fragments/k8s_auth_options.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/k8s_name_options.py (renamed from lib/ansible/utils/module_docs_fragments/k8s_name_options.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/k8s_resource_options.py (renamed from lib/ansible/utils/module_docs_fragments/k8s_resource_options.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/k8s_scale_options.py (renamed from lib/ansible/utils/module_docs_fragments/k8s_scale_options.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/k8s_state_options.py (renamed from lib/ansible/utils/module_docs_fragments/k8s_state_options.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/keycloak.py (renamed from lib/ansible/utils/module_docs_fragments/keycloak.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ldap.py (renamed from lib/ansible/utils/module_docs_fragments/ldap.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/lxca_common.py (renamed from lib/ansible/utils/module_docs_fragments/lxca_common.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/manageiq.py (renamed from lib/ansible/utils/module_docs_fragments/manageiq.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/meraki.py (renamed from lib/ansible/utils/module_docs_fragments/meraki.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/mso.py (renamed from lib/ansible/utils/module_docs_fragments/mso.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/mysql.py (renamed from lib/ansible/utils/module_docs_fragments/mysql.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/netapp.py (renamed from lib/ansible/utils/module_docs_fragments/netapp.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/netconf.py (renamed from lib/ansible/utils/module_docs_fragments/netconf.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/netscaler.py (renamed from lib/ansible/utils/module_docs_fragments/netscaler.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/nios.py (renamed from lib/ansible/utils/module_docs_fragments/nios.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/nso.py (renamed from lib/ansible/utils/module_docs_fragments/nso.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/nxos.py (renamed from lib/ansible/utils/module_docs_fragments/nxos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/oneview.py (renamed from lib/ansible/utils/module_docs_fragments/oneview.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/online.py (renamed from lib/ansible/utils/module_docs_fragments/online.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/onyx.py (renamed from lib/ansible/utils/module_docs_fragments/onyx.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/opennebula.py (renamed from lib/ansible/utils/module_docs_fragments/opennebula.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/openstack.py (renamed from lib/ansible/utils/module_docs_fragments/openstack.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/openswitch.py (renamed from lib/ansible/utils/module_docs_fragments/openswitch.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ovirt.py (renamed from lib/ansible/utils/module_docs_fragments/ovirt.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ovirt_facts.py (renamed from lib/ansible/utils/module_docs_fragments/ovirt_facts.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/panos.py (renamed from lib/ansible/utils/module_docs_fragments/panos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/postgres.py (renamed from lib/ansible/utils/module_docs_fragments/postgres.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/proxysql.py (renamed from lib/ansible/utils/module_docs_fragments/proxysql.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/purestorage.py (renamed from lib/ansible/utils/module_docs_fragments/purestorage.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/rabbitmq.py (renamed from lib/ansible/utils/module_docs_fragments/rabbitmq.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/rackspace.py (renamed from lib/ansible/utils/module_docs_fragments/rackspace.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/return_common.py (renamed from lib/ansible/utils/module_docs_fragments/return_common.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/scaleway.py (renamed from lib/ansible/utils/module_docs_fragments/scaleway.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/shell_common.py (renamed from lib/ansible/utils/module_docs_fragments/shell_common.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/sros.py (renamed from lib/ansible/utils/module_docs_fragments/sros.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/tower.py (renamed from lib/ansible/utils/module_docs_fragments/tower.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/ucs.py (renamed from lib/ansible/utils/module_docs_fragments/ucs.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/url.py (renamed from lib/ansible/utils/module_docs_fragments/url.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/utm.py (renamed from lib/ansible/utils/module_docs_fragments/utm.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/validate.py (renamed from lib/ansible/utils/module_docs_fragments/validate.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/vca.py (renamed from lib/ansible/utils/module_docs_fragments/vca.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/vmware.py (renamed from lib/ansible/utils/module_docs_fragments/vmware.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/vmware_rest_client.py (renamed from lib/ansible/utils/module_docs_fragments/vmware_rest_client.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/vultr.py (renamed from lib/ansible/utils/module_docs_fragments/vultr.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/vyos.py (renamed from lib/ansible/utils/module_docs_fragments/vyos.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/xenserver.py (renamed from lib/ansible/utils/module_docs_fragments/xenserver.py)0
-rw-r--r--lib/ansible/plugins/doc_fragments/zabbix.py (renamed from lib/ansible/utils/module_docs_fragments/zabbix.py)0
-rw-r--r--lib/ansible/plugins/loader.py7
-rw-r--r--lib/ansible/utils/plugin_docs.py2
-rw-r--r--test/runner/lib/classification.py2
-rw-r--r--test/runner/lib/sanity/ansible_doc.py2
-rw-r--r--test/runner/lib/sanity/yamllint.py2
-rwxr-xr-xtest/sanity/code-smell/boilerplate.py2
-rwxr-xr-xtest/sanity/yamllint/yamllinter.py2
106 files changed, 51 insertions, 31 deletions
diff --git a/.github/BOTMETA.yml b/.github/BOTMETA.yml
index 915896234c..55e6c641b9 100644
--- a/.github/BOTMETA.yml
+++ b/.github/BOTMETA.yml
@@ -1025,6 +1025,28 @@ files:
labels:
- windows
###############################
+# plugins/doc_fragments
+ $plugins/doc_fragments/:
+ support: community
+ $plugins/doc_fragments/__init__.py:
+ support: core
+ $plugins/doc_fragments/aci.py: *aci
+ $plugins/doc_fragments/acme.py:
+ maintainers: resmo felixfontein
+ $plugins/doc_fragments/cloudstack.py:
+ maintainers: $team_cloudstack
+ labels: cloudstack
+ $plugins/doc_fragments/docker.py:
+ support: community
+ maintainers: $team_docker
+ supershipit: felixfontein
+ $plugins/doc_fragments/mso.py: *aci
+ $plugins/doc_fragments/vultr.py:
+ maintainers: $team_vultr
+ labels: cloud
+ $plugins/doc_fragments/xenserver.py:
+ maintainers: bvitnik
+###############################
# plugins/filter
$plugins/filter/:
support: community
@@ -1211,24 +1233,6 @@ files:
keywords:
- jinja
- jinja2
- lib/ansible/utils/module_docs_fragments/:
- support: community
- lib/ansible/utils/module_docs_fragments/aci.py: *aci
- lib/ansible/utils/module_docs_fragments/acme.py:
- maintainers: resmo felixfontein
- lib/ansible/utils/module_docs_fragments/docker.py:
- support: community
- maintainers: $team_docker
- supershipit: felixfontein
- lib/ansible/utils/module_docs_fragments/mso.py: *aci
- lib/ansible/utils/module_docs_fragments/xenserver.py:
- maintainers: bvitnik
- lib/ansible/utils/module_docs_fragments/cloudstack.py:
- maintainers: $team_cloudstack
- labels: cloudstack
- lib/ansible/utils/module_docs_fragments/vultr.py:
- maintainers: $team_vultr
- labels: cloud
test/sanity/validate-modules:
notified:
- mattclay
diff --git a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst
index 6c86046701..1613567ed3 100644
--- a/docs/docsite/rst/dev_guide/developing_modules_documenting.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules_documenting.rst
@@ -272,7 +272,14 @@ You can link from your module documentation to other module docs, other resource
Documentation fragments
-----------------------
-If you're writing multiple related modules, they may share common documentation, such as authentication details or file mode settings. Rather than duplicate that information in each module's ``DOCUMENTATION`` block, you can save it once as a fragment and use it in each module's documentation. Shared documentation fragments are contained in a ``ModuleDocFragment`` class in `lib/ansible/utils/module_docs_fragments/ <https://github.com/ansible/ansible/tree/devel/lib/ansible/utils/module_docs_fragments>`_. To include a documentation fragment, add ``extends_documentation_fragment: FRAGMENT_NAME`` in your module's documentation.
+If you're writing multiple related modules, they may share common documentation, such as authentication details or file mode settings. Rather than duplicate that information in each module's ``DOCUMENTATION`` block, you can save it once as a doc_fragment plugin and use it in each module's documentation. In Ansible, shared documentation fragments are contained in a ``ModuleDocFragment`` class in `lib/ansible/plugins/doc_fragments/ <https://github.com/ansible/ansible/tree/devel/lib/ansible/plugins/doc_fragments>`_. To include a documentation fragment, add ``extends_documentation_fragment: FRAGMENT_NAME`` in your module's documentation.
+
+.. _note:
+ * in 2.8 the Ansible directories for doc fragments changed, see documentation of previous versions to find the old locations.
+
+.. versionadded:: 2.8
+
+Since version 2.8, you can have user supplied doc_fragments by using a ``doc_fragments`` directory adjacent to play or role, just like any other plugin.
For example, all AWS modules should include::
diff --git a/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst b/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst
index e9c383fbab..89d32ccadc 100644
--- a/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst
+++ b/docs/docsite/rst/dev_guide/developing_modules_in_groups.rst
@@ -28,7 +28,7 @@ Although it's tempting to get straight into coding, there are a few things to be
* Starting with Ansible version 2.7, all new modules must :ref:`support Python 2.7+ and Python 3.5+ <developing_python_3>`. If this is an issue, please contact us (see the "Speak to us" section later in this document to learn how).
* Have a look at the existing modules and how they've been named in the :ref:`all_modules`, especially in the same functional area (such as cloud, networking, databases).
* Shared code can be placed into ``lib/ansible/module_utils/``
-* Shared documentation (for example describing common arguments) can be placed in ``lib/ansible/utils/module_docs_fragments/``.
+* Shared documentation (for example describing common arguments) can be placed in ``lib/ansible/plugins/doc_fragments/``.
* With great power comes great responsibility: Ansible module maintainers have a duty to help keep modules up to date. As with all successful community projects, module maintainers should keep a watchful eye for reported issues and contributions.
* Although not required, unit and/or integration tests are strongly recommended. Unit tests are especially valuable when external resources (such as cloud or network devices) are required. For more information see :doc:`testing` and the `Testing Working Group <https://github.com/ansible/community/blob/master/meetings/README.md>`_.
* Starting with Ansible 2.4 all :ref:`network_modules` MUST have unit tests.
@@ -81,7 +81,7 @@ The first PR is slightly different to the rest because it:
* defines the namespace
* provides a basis for detailed review that will help shape your future PRs
-* may include shared documentation (`docs_fragments`) that multiple modules require
+* may include shared documentation (`doc_fragments`) that multiple modules require
* may include shared code (`module_utils`) that multiple modules require
@@ -89,7 +89,7 @@ The first PR should include the following files:
* ``lib/ansible/modules/$category/$topic/__init__.py`` - An empty file to initialize namespace and allow Python to import the files. *Required new file*
* ``lib/ansible/modules/$category/$topic/$yourfirstmodule.py`` - A single module. *Required new file*
-* ``lib/ansible/utils/module_docs_fragments/$topic.py`` - Code documentation, such as details regarding common arguments. *Optional new file*
+* ``lib/ansible/plugins/doc_fragments/$topic.py`` - Code documentation, such as details regarding common arguments. *Optional new file*
* ``lib/ansible/module_utils/$topic.py`` - Code shared between more than one module, such as common arguments. *Optional new file*
* ``docs/docsite/rst/dev_guide/developing_module_utilities.rst`` - Document your new `module_utils` file. *Optional update to existing file*
diff --git a/lib/ansible/config/base.yml b/lib/ansible/config/base.yml
index 5d5630d7c3..60d59ef90d 100644
--- a/lib/ansible/config/base.yml
+++ b/lib/ansible/config/base.yml
@@ -352,6 +352,14 @@ LOCALHOST_WARNING:
- {key: localhost_warning, section: defaults}
type: boolean
version_added: "2.6"
+DOC_FRAGMENT_PLUGIN_PATH:
+ name: documentation fragment plugins path
+ default: ~/.ansible/plugins/doc_fragments:/usr/share/ansible/plugins/doc_fragments
+ description: Colon separated paths in which Ansible will search for Documentation Fragments Plugins.
+ env: [{name: ANSIBLE_DOC_FRAGMENT_PLUGINS}]
+ ini:
+ - {key: doc_fragment_plugins, section: defaults}
+ type: pathspec
DEFAULT_ACTION_PLUGIN_PATH:
name: Action plugins path
default: ~/.ansible/plugins/action:/usr/share/ansible/plugins/action
diff --git a/lib/ansible/utils/module_docs_fragments/__init__.py b/lib/ansible/plugins/doc_fragments/__init__.py
index e69de29bb2..e69de29bb2 100644
--- a/lib/ansible/utils/module_docs_fragments/__init__.py
+++ b/lib/ansible/plugins/doc_fragments/__init__.py
diff --git a/lib/ansible/utils/module_docs_fragments/a10.py b/lib/ansible/plugins/doc_fragments/a10.py
index 088f3e95da..088f3e95da 100644
--- a/lib/ansible/utils/module_docs_fragments/a10.py
+++ b/lib/ansible/plugins/doc_fragments/a10.py
diff --git a/lib/ansible/utils/module_docs_fragments/aci.py b/lib/ansible/plugins/doc_fragments/aci.py
index 54b371108f..54b371108f 100644
--- a/lib/ansible/utils/module_docs_fragments/aci.py
+++ b/lib/ansible/plugins/doc_fragments/aci.py
diff --git a/lib/ansible/utils/module_docs_fragments/acme.py b/lib/ansible/plugins/doc_fragments/acme.py
index c058435b57..c058435b57 100644
--- a/lib/ansible/utils/module_docs_fragments/acme.py
+++ b/lib/ansible/plugins/doc_fragments/acme.py
diff --git a/lib/ansible/utils/module_docs_fragments/aireos.py b/lib/ansible/plugins/doc_fragments/aireos.py
index 6f623a3a0c..6f623a3a0c 100644
--- a/lib/ansible/utils/module_docs_fragments/aireos.py
+++ b/lib/ansible/plugins/doc_fragments/aireos.py
diff --git a/lib/ansible/utils/module_docs_fragments/alicloud.py b/lib/ansible/plugins/doc_fragments/alicloud.py
index e94f4fed00..e94f4fed00 100644
--- a/lib/ansible/utils/module_docs_fragments/alicloud.py
+++ b/lib/ansible/plugins/doc_fragments/alicloud.py
diff --git a/lib/ansible/utils/module_docs_fragments/aruba.py b/lib/ansible/plugins/doc_fragments/aruba.py
index 6f623a3a0c..6f623a3a0c 100644
--- a/lib/ansible/utils/module_docs_fragments/aruba.py
+++ b/lib/ansible/plugins/doc_fragments/aruba.py
diff --git a/lib/ansible/utils/module_docs_fragments/asa.py b/lib/ansible/plugins/doc_fragments/asa.py
index 183ba3b693..183ba3b693 100644
--- a/lib/ansible/utils/module_docs_fragments/asa.py
+++ b/lib/ansible/plugins/doc_fragments/asa.py
diff --git a/lib/ansible/utils/module_docs_fragments/auth_basic.py b/lib/ansible/plugins/doc_fragments/auth_basic.py
index 22620a9a20..22620a9a20 100644
--- a/lib/ansible/utils/module_docs_fragments/auth_basic.py
+++ b/lib/ansible/plugins/doc_fragments/auth_basic.py
diff --git a/lib/ansible/utils/module_docs_fragments/avi.py b/lib/ansible/plugins/doc_fragments/avi.py
index 5e034fe540..5e034fe540 100644
--- a/lib/ansible/utils/module_docs_fragments/avi.py
+++ b/lib/ansible/plugins/doc_fragments/avi.py
diff --git a/lib/ansible/utils/module_docs_fragments/aws.py b/lib/ansible/plugins/doc_fragments/aws.py
index 56090c0b26..56090c0b26 100644
--- a/lib/ansible/utils/module_docs_fragments/aws.py
+++ b/lib/ansible/plugins/doc_fragments/aws.py
diff --git a/lib/ansible/utils/module_docs_fragments/aws_credentials.py b/lib/ansible/plugins/doc_fragments/aws_credentials.py
index 61bdcf6d18..61bdcf6d18 100644
--- a/lib/ansible/utils/module_docs_fragments/aws_credentials.py
+++ b/lib/ansible/plugins/doc_fragments/aws_credentials.py
diff --git a/lib/ansible/utils/module_docs_fragments/azure.py b/lib/ansible/plugins/doc_fragments/azure.py
index 6701e2d304..6701e2d304 100644
--- a/lib/ansible/utils/module_docs_fragments/azure.py
+++ b/lib/ansible/plugins/doc_fragments/azure.py
diff --git a/lib/ansible/utils/module_docs_fragments/azure_tags.py b/lib/ansible/plugins/doc_fragments/azure_tags.py
index ff8579fde4..ff8579fde4 100644
--- a/lib/ansible/utils/module_docs_fragments/azure_tags.py
+++ b/lib/ansible/plugins/doc_fragments/azure_tags.py
diff --git a/lib/ansible/utils/module_docs_fragments/backup.py b/lib/ansible/plugins/doc_fragments/backup.py
index 5d46528f26..5d46528f26 100644
--- a/lib/ansible/utils/module_docs_fragments/backup.py
+++ b/lib/ansible/plugins/doc_fragments/backup.py
diff --git a/lib/ansible/utils/module_docs_fragments/ce.py b/lib/ansible/plugins/doc_fragments/ce.py
index 7a5f006ae8..7a5f006ae8 100644
--- a/lib/ansible/utils/module_docs_fragments/ce.py
+++ b/lib/ansible/plugins/doc_fragments/ce.py
diff --git a/lib/ansible/utils/module_docs_fragments/cloudstack.py b/lib/ansible/plugins/doc_fragments/cloudstack.py
index 63c6f3ce7a..63c6f3ce7a 100644
--- a/lib/ansible/utils/module_docs_fragments/cloudstack.py
+++ b/lib/ansible/plugins/doc_fragments/cloudstack.py
diff --git a/lib/ansible/utils/module_docs_fragments/cnos.py b/lib/ansible/plugins/doc_fragments/cnos.py
index 3f41a2c564..3f41a2c564 100644
--- a/lib/ansible/utils/module_docs_fragments/cnos.py
+++ b/lib/ansible/plugins/doc_fragments/cnos.py
diff --git a/lib/ansible/utils/module_docs_fragments/constructed.py b/lib/ansible/plugins/doc_fragments/constructed.py
index 4f8036abdc..4f8036abdc 100644
--- a/lib/ansible/utils/module_docs_fragments/constructed.py
+++ b/lib/ansible/plugins/doc_fragments/constructed.py
diff --git a/lib/ansible/utils/module_docs_fragments/decrypt.py b/lib/ansible/plugins/doc_fragments/decrypt.py
index 3b33cf5fa1..3b33cf5fa1 100644
--- a/lib/ansible/utils/module_docs_fragments/decrypt.py
+++ b/lib/ansible/plugins/doc_fragments/decrypt.py
diff --git a/lib/ansible/utils/module_docs_fragments/default_callback.py b/lib/ansible/plugins/doc_fragments/default_callback.py
index ec56a28850..ec56a28850 100644
--- a/lib/ansible/utils/module_docs_fragments/default_callback.py
+++ b/lib/ansible/plugins/doc_fragments/default_callback.py
diff --git a/lib/ansible/utils/module_docs_fragments/dellos10.py b/lib/ansible/plugins/doc_fragments/dellos10.py
index 71c70cec48..71c70cec48 100644
--- a/lib/ansible/utils/module_docs_fragments/dellos10.py
+++ b/lib/ansible/plugins/doc_fragments/dellos10.py
diff --git a/lib/ansible/utils/module_docs_fragments/dellos6.py b/lib/ansible/plugins/doc_fragments/dellos6.py
index 61fe4b2dfe..61fe4b2dfe 100644
--- a/lib/ansible/utils/module_docs_fragments/dellos6.py
+++ b/lib/ansible/plugins/doc_fragments/dellos6.py
diff --git a/lib/ansible/utils/module_docs_fragments/dellos9.py b/lib/ansible/plugins/doc_fragments/dellos9.py
index 4afb580411..4afb580411 100644
--- a/lib/ansible/utils/module_docs_fragments/dellos9.py
+++ b/lib/ansible/plugins/doc_fragments/dellos9.py
diff --git a/lib/ansible/utils/module_docs_fragments/digital_ocean.py b/lib/ansible/plugins/doc_fragments/digital_ocean.py
index f592c6c46f..f592c6c46f 100644
--- a/lib/ansible/utils/module_docs_fragments/digital_ocean.py
+++ b/lib/ansible/plugins/doc_fragments/digital_ocean.py
diff --git a/lib/ansible/utils/module_docs_fragments/dimensiondata.py b/lib/ansible/plugins/doc_fragments/dimensiondata.py
index ef40b200ef..ef40b200ef 100644
--- a/lib/ansible/utils/module_docs_fragments/dimensiondata.py
+++ b/lib/ansible/plugins/doc_fragments/dimensiondata.py
diff --git a/lib/ansible/utils/module_docs_fragments/dimensiondata_wait.py b/lib/ansible/plugins/doc_fragments/dimensiondata_wait.py
index 37c5327234..37c5327234 100644
--- a/lib/ansible/utils/module_docs_fragments/dimensiondata_wait.py
+++ b/lib/ansible/plugins/doc_fragments/dimensiondata_wait.py
diff --git a/lib/ansible/utils/module_docs_fragments/docker.py b/lib/ansible/plugins/doc_fragments/docker.py
index 093d7e9b01..093d7e9b01 100644
--- a/lib/ansible/utils/module_docs_fragments/docker.py
+++ b/lib/ansible/plugins/doc_fragments/docker.py
diff --git a/lib/ansible/utils/module_docs_fragments/ec2.py b/lib/ansible/plugins/doc_fragments/ec2.py
index 5485f484af..5485f484af 100644
--- a/lib/ansible/utils/module_docs_fragments/ec2.py
+++ b/lib/ansible/plugins/doc_fragments/ec2.py
diff --git a/lib/ansible/utils/module_docs_fragments/emc.py b/lib/ansible/plugins/doc_fragments/emc.py
index 9d75b9396d..9d75b9396d 100644
--- a/lib/ansible/utils/module_docs_fragments/emc.py
+++ b/lib/ansible/plugins/doc_fragments/emc.py
diff --git a/lib/ansible/utils/module_docs_fragments/enos.py b/lib/ansible/plugins/doc_fragments/enos.py
index 128608f28e..128608f28e 100644
--- a/lib/ansible/utils/module_docs_fragments/enos.py
+++ b/lib/ansible/plugins/doc_fragments/enos.py
diff --git a/lib/ansible/utils/module_docs_fragments/eos.py b/lib/ansible/plugins/doc_fragments/eos.py
index 0252d1dcd8..0252d1dcd8 100644
--- a/lib/ansible/utils/module_docs_fragments/eos.py
+++ b/lib/ansible/plugins/doc_fragments/eos.py
diff --git a/lib/ansible/utils/module_docs_fragments/exoscale.py b/lib/ansible/plugins/doc_fragments/exoscale.py
index d1352551fa..d1352551fa 100644
--- a/lib/ansible/utils/module_docs_fragments/exoscale.py
+++ b/lib/ansible/plugins/doc_fragments/exoscale.py
diff --git a/lib/ansible/utils/module_docs_fragments/f5.py b/lib/ansible/plugins/doc_fragments/f5.py
index 798bd9ced6..798bd9ced6 100644
--- a/lib/ansible/utils/module_docs_fragments/f5.py
+++ b/lib/ansible/plugins/doc_fragments/f5.py
diff --git a/lib/ansible/utils/module_docs_fragments/files.py b/lib/ansible/plugins/doc_fragments/files.py
index 75ee6c8834..75ee6c8834 100644
--- a/lib/ansible/utils/module_docs_fragments/files.py
+++ b/lib/ansible/plugins/doc_fragments/files.py
diff --git a/lib/ansible/utils/module_docs_fragments/fortios.py b/lib/ansible/plugins/doc_fragments/fortios.py
index d53bbc007a..d53bbc007a 100644
--- a/lib/ansible/utils/module_docs_fragments/fortios.py
+++ b/lib/ansible/plugins/doc_fragments/fortios.py
diff --git a/lib/ansible/utils/module_docs_fragments/gcp.py b/lib/ansible/plugins/doc_fragments/gcp.py
index e736e5d4de..e736e5d4de 100644
--- a/lib/ansible/utils/module_docs_fragments/gcp.py
+++ b/lib/ansible/plugins/doc_fragments/gcp.py
diff --git a/lib/ansible/utils/module_docs_fragments/ibm_storage.py b/lib/ansible/plugins/doc_fragments/ibm_storage.py
index 371ef91376..371ef91376 100644
--- a/lib/ansible/utils/module_docs_fragments/ibm_storage.py
+++ b/lib/ansible/plugins/doc_fragments/ibm_storage.py
diff --git a/lib/ansible/utils/module_docs_fragments/infinibox.py b/lib/ansible/plugins/doc_fragments/infinibox.py
index cd3834d5e4..cd3834d5e4 100644
--- a/lib/ansible/utils/module_docs_fragments/infinibox.py
+++ b/lib/ansible/plugins/doc_fragments/infinibox.py
diff --git a/lib/ansible/utils/module_docs_fragments/influxdb.py b/lib/ansible/plugins/doc_fragments/influxdb.py
index ac4c2ed781..ac4c2ed781 100644
--- a/lib/ansible/utils/module_docs_fragments/influxdb.py
+++ b/lib/ansible/plugins/doc_fragments/influxdb.py
diff --git a/lib/ansible/utils/module_docs_fragments/ingate.py b/lib/ansible/plugins/doc_fragments/ingate.py
index 1b07d2dd5f..1b07d2dd5f 100644
--- a/lib/ansible/utils/module_docs_fragments/ingate.py
+++ b/lib/ansible/plugins/doc_fragments/ingate.py
diff --git a/lib/ansible/utils/module_docs_fragments/inventory_cache.py b/lib/ansible/plugins/doc_fragments/inventory_cache.py
index 784f899ad7..784f899ad7 100644
--- a/lib/ansible/utils/module_docs_fragments/inventory_cache.py
+++ b/lib/ansible/plugins/doc_fragments/inventory_cache.py
diff --git a/lib/ansible/utils/module_docs_fragments/ios.py b/lib/ansible/plugins/doc_fragments/ios.py
index b53aa31655..b53aa31655 100644
--- a/lib/ansible/utils/module_docs_fragments/ios.py
+++ b/lib/ansible/plugins/doc_fragments/ios.py
diff --git a/lib/ansible/utils/module_docs_fragments/iosxr.py b/lib/ansible/plugins/doc_fragments/iosxr.py
index c54046b2af..c54046b2af 100644
--- a/lib/ansible/utils/module_docs_fragments/iosxr.py
+++ b/lib/ansible/plugins/doc_fragments/iosxr.py
diff --git a/lib/ansible/utils/module_docs_fragments/ipa.py b/lib/ansible/plugins/doc_fragments/ipa.py
index d2017b7e4e..d2017b7e4e 100644
--- a/lib/ansible/utils/module_docs_fragments/ipa.py
+++ b/lib/ansible/plugins/doc_fragments/ipa.py
diff --git a/lib/ansible/utils/module_docs_fragments/ironware.py b/lib/ansible/plugins/doc_fragments/ironware.py
index 7a57478e7d..7a57478e7d 100644
--- a/lib/ansible/utils/module_docs_fragments/ironware.py
+++ b/lib/ansible/plugins/doc_fragments/ironware.py
diff --git a/lib/ansible/utils/module_docs_fragments/junos.py b/lib/ansible/plugins/doc_fragments/junos.py
index d8596862b5..d8596862b5 100644
--- a/lib/ansible/utils/module_docs_fragments/junos.py
+++ b/lib/ansible/plugins/doc_fragments/junos.py
diff --git a/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py b/lib/ansible/plugins/doc_fragments/k8s_auth_options.py
index b24cbfaab9..b24cbfaab9 100644
--- a/lib/ansible/utils/module_docs_fragments/k8s_auth_options.py
+++ b/lib/ansible/plugins/doc_fragments/k8s_auth_options.py
diff --git a/lib/ansible/utils/module_docs_fragments/k8s_name_options.py b/lib/ansible/plugins/doc_fragments/k8s_name_options.py
index 74e693c396..74e693c396 100644
--- a/lib/ansible/utils/module_docs_fragments/k8s_name_options.py
+++ b/lib/ansible/plugins/doc_fragments/k8s_name_options.py
diff --git a/lib/ansible/utils/module_docs_fragments/k8s_resource_options.py b/lib/ansible/plugins/doc_fragments/k8s_resource_options.py
index 25adb32db5..25adb32db5 100644
--- a/lib/ansible/utils/module_docs_fragments/k8s_resource_options.py
+++ b/lib/ansible/plugins/doc_fragments/k8s_resource_options.py
diff --git a/lib/ansible/utils/module_docs_fragments/k8s_scale_options.py b/lib/ansible/plugins/doc_fragments/k8s_scale_options.py
index 6eef7cbb8f..6eef7cbb8f 100644
--- a/lib/ansible/utils/module_docs_fragments/k8s_scale_options.py
+++ b/lib/ansible/plugins/doc_fragments/k8s_scale_options.py
diff --git a/lib/ansible/utils/module_docs_fragments/k8s_state_options.py b/lib/ansible/plugins/doc_fragments/k8s_state_options.py
index 660d6db98c..660d6db98c 100644
--- a/lib/ansible/utils/module_docs_fragments/k8s_state_options.py
+++ b/lib/ansible/plugins/doc_fragments/k8s_state_options.py
diff --git a/lib/ansible/utils/module_docs_fragments/keycloak.py b/lib/ansible/plugins/doc_fragments/keycloak.py
index bd0c36b20b..bd0c36b20b 100644
--- a/lib/ansible/utils/module_docs_fragments/keycloak.py
+++ b/lib/ansible/plugins/doc_fragments/keycloak.py
diff --git a/lib/ansible/utils/module_docs_fragments/ldap.py b/lib/ansible/plugins/doc_fragments/ldap.py
index e76a2ee7b3..e76a2ee7b3 100644
--- a/lib/ansible/utils/module_docs_fragments/ldap.py
+++ b/lib/ansible/plugins/doc_fragments/ldap.py
diff --git a/lib/ansible/utils/module_docs_fragments/lxca_common.py b/lib/ansible/plugins/doc_fragments/lxca_common.py
index cf06b85051..cf06b85051 100644
--- a/lib/ansible/utils/module_docs_fragments/lxca_common.py
+++ b/lib/ansible/plugins/doc_fragments/lxca_common.py
diff --git a/lib/ansible/utils/module_docs_fragments/manageiq.py b/lib/ansible/plugins/doc_fragments/manageiq.py
index 397b65df48..397b65df48 100644
--- a/lib/ansible/utils/module_docs_fragments/manageiq.py
+++ b/lib/ansible/plugins/doc_fragments/manageiq.py
diff --git a/lib/ansible/utils/module_docs_fragments/meraki.py b/lib/ansible/plugins/doc_fragments/meraki.py
index ea4ea44339..ea4ea44339 100644
--- a/lib/ansible/utils/module_docs_fragments/meraki.py
+++ b/lib/ansible/plugins/doc_fragments/meraki.py
diff --git a/lib/ansible/utils/module_docs_fragments/mso.py b/lib/ansible/plugins/doc_fragments/mso.py
index 8add92c8c5..8add92c8c5 100644
--- a/lib/ansible/utils/module_docs_fragments/mso.py
+++ b/lib/ansible/plugins/doc_fragments/mso.py
diff --git a/lib/ansible/utils/module_docs_fragments/mysql.py b/lib/ansible/plugins/doc_fragments/mysql.py
index 58a9deac95..58a9deac95 100644
--- a/lib/ansible/utils/module_docs_fragments/mysql.py
+++ b/lib/ansible/plugins/doc_fragments/mysql.py
diff --git a/lib/ansible/utils/module_docs_fragments/netapp.py b/lib/ansible/plugins/doc_fragments/netapp.py
index ee65e81cb6..ee65e81cb6 100644
--- a/lib/ansible/utils/module_docs_fragments/netapp.py
+++ b/lib/ansible/plugins/doc_fragments/netapp.py
diff --git a/lib/ansible/utils/module_docs_fragments/netconf.py b/lib/ansible/plugins/doc_fragments/netconf.py
index b578fc31b4..b578fc31b4 100644
--- a/lib/ansible/utils/module_docs_fragments/netconf.py
+++ b/lib/ansible/plugins/doc_fragments/netconf.py
diff --git a/lib/ansible/utils/module_docs_fragments/netscaler.py b/lib/ansible/plugins/doc_fragments/netscaler.py
index 3f47b2c32e..3f47b2c32e 100644
--- a/lib/ansible/utils/module_docs_fragments/netscaler.py
+++ b/lib/ansible/plugins/doc_fragments/netscaler.py
diff --git a/lib/ansible/utils/module_docs_fragments/nios.py b/lib/ansible/plugins/doc_fragments/nios.py
index b05de60c1d..b05de60c1d 100644
--- a/lib/ansible/utils/module_docs_fragments/nios.py
+++ b/lib/ansible/plugins/doc_fragments/nios.py
diff --git a/lib/ansible/utils/module_docs_fragments/nso.py b/lib/ansible/plugins/doc_fragments/nso.py
index aaa16a7468..aaa16a7468 100644
--- a/lib/ansible/utils/module_docs_fragments/nso.py
+++ b/lib/ansible/plugins/doc_fragments/nso.py
diff --git a/lib/ansible/utils/module_docs_fragments/nxos.py b/lib/ansible/plugins/doc_fragments/nxos.py
index 24cc086c83..24cc086c83 100644
--- a/lib/ansible/utils/module_docs_fragments/nxos.py
+++ b/lib/ansible/plugins/doc_fragments/nxos.py
diff --git a/lib/ansible/utils/module_docs_fragments/oneview.py b/lib/ansible/plugins/doc_fragments/oneview.py
index 73b2eb6548..73b2eb6548 100644
--- a/lib/ansible/utils/module_docs_fragments/oneview.py
+++ b/lib/ansible/plugins/doc_fragments/oneview.py
diff --git a/lib/ansible/utils/module_docs_fragments/online.py b/lib/ansible/plugins/doc_fragments/online.py
index b5303a2ef6..b5303a2ef6 100644
--- a/lib/ansible/utils/module_docs_fragments/online.py
+++ b/lib/ansible/plugins/doc_fragments/online.py
diff --git a/lib/ansible/utils/module_docs_fragments/onyx.py b/lib/ansible/plugins/doc_fragments/onyx.py
index 0cc80cee97..0cc80cee97 100644
--- a/lib/ansible/utils/module_docs_fragments/onyx.py
+++ b/lib/ansible/plugins/doc_fragments/onyx.py
diff --git a/lib/ansible/utils/module_docs_fragments/opennebula.py b/lib/ansible/plugins/doc_fragments/opennebula.py
index 233d036a78..233d036a78 100644
--- a/lib/ansible/utils/module_docs_fragments/opennebula.py
+++ b/lib/ansible/plugins/doc_fragments/opennebula.py
diff --git a/lib/ansible/utils/module_docs_fragments/openstack.py b/lib/ansible/plugins/doc_fragments/openstack.py
index 9bcc2b7ed5..9bcc2b7ed5 100644
--- a/lib/ansible/utils/module_docs_fragments/openstack.py
+++ b/lib/ansible/plugins/doc_fragments/openstack.py
diff --git a/lib/ansible/utils/module_docs_fragments/openswitch.py b/lib/ansible/plugins/doc_fragments/openswitch.py
index b0dfaec342..b0dfaec342 100644
--- a/lib/ansible/utils/module_docs_fragments/openswitch.py
+++ b/lib/ansible/plugins/doc_fragments/openswitch.py
diff --git a/lib/ansible/utils/module_docs_fragments/ovirt.py b/lib/ansible/plugins/doc_fragments/ovirt.py
index bcea8d433c..bcea8d433c 100644
--- a/lib/ansible/utils/module_docs_fragments/ovirt.py
+++ b/lib/ansible/plugins/doc_fragments/ovirt.py
diff --git a/lib/ansible/utils/module_docs_fragments/ovirt_facts.py b/lib/ansible/plugins/doc_fragments/ovirt_facts.py
index 564898ef55..564898ef55 100644
--- a/lib/ansible/utils/module_docs_fragments/ovirt_facts.py
+++ b/lib/ansible/plugins/doc_fragments/ovirt_facts.py
diff --git a/lib/ansible/utils/module_docs_fragments/panos.py b/lib/ansible/plugins/doc_fragments/panos.py
index eb666699f4..eb666699f4 100644
--- a/lib/ansible/utils/module_docs_fragments/panos.py
+++ b/lib/ansible/plugins/doc_fragments/panos.py
diff --git a/lib/ansible/utils/module_docs_fragments/postgres.py b/lib/ansible/plugins/doc_fragments/postgres.py
index 5068ea064f..5068ea064f 100644
--- a/lib/ansible/utils/module_docs_fragments/postgres.py
+++ b/lib/ansible/plugins/doc_fragments/postgres.py
diff --git a/lib/ansible/utils/module_docs_fragments/proxysql.py b/lib/ansible/plugins/doc_fragments/proxysql.py
index ad65911cf9..ad65911cf9 100644
--- a/lib/ansible/utils/module_docs_fragments/proxysql.py
+++ b/lib/ansible/plugins/doc_fragments/proxysql.py
diff --git a/lib/ansible/utils/module_docs_fragments/purestorage.py b/lib/ansible/plugins/doc_fragments/purestorage.py
index 8e780c5b3a..8e780c5b3a 100644
--- a/lib/ansible/utils/module_docs_fragments/purestorage.py
+++ b/lib/ansible/plugins/doc_fragments/purestorage.py
diff --git a/lib/ansible/utils/module_docs_fragments/rabbitmq.py b/lib/ansible/plugins/doc_fragments/rabbitmq.py
index 87c52346d6..87c52346d6 100644
--- a/lib/ansible/utils/module_docs_fragments/rabbitmq.py
+++ b/lib/ansible/plugins/doc_fragments/rabbitmq.py
diff --git a/lib/ansible/utils/module_docs_fragments/rackspace.py b/lib/ansible/plugins/doc_fragments/rackspace.py
index c3312f75b2..c3312f75b2 100644
--- a/lib/ansible/utils/module_docs_fragments/rackspace.py
+++ b/lib/ansible/plugins/doc_fragments/rackspace.py
diff --git a/lib/ansible/utils/module_docs_fragments/return_common.py b/lib/ansible/plugins/doc_fragments/return_common.py
index 998e1a0558..998e1a0558 100644
--- a/lib/ansible/utils/module_docs_fragments/return_common.py
+++ b/lib/ansible/plugins/doc_fragments/return_common.py
diff --git a/lib/ansible/utils/module_docs_fragments/scaleway.py b/lib/ansible/plugins/doc_fragments/scaleway.py
index b21cad2aa1..b21cad2aa1 100644
--- a/lib/ansible/utils/module_docs_fragments/scaleway.py
+++ b/lib/ansible/plugins/doc_fragments/scaleway.py
diff --git a/lib/ansible/utils/module_docs_fragments/shell_common.py b/lib/ansible/plugins/doc_fragments/shell_common.py
index d3b78e12ac..d3b78e12ac 100644
--- a/lib/ansible/utils/module_docs_fragments/shell_common.py
+++ b/lib/ansible/plugins/doc_fragments/shell_common.py
diff --git a/lib/ansible/utils/module_docs_fragments/sros.py b/lib/ansible/plugins/doc_fragments/sros.py
index 667e9800eb..667e9800eb 100644
--- a/lib/ansible/utils/module_docs_fragments/sros.py
+++ b/lib/ansible/plugins/doc_fragments/sros.py
diff --git a/lib/ansible/utils/module_docs_fragments/tower.py b/lib/ansible/plugins/doc_fragments/tower.py
index 8e51af57c3..8e51af57c3 100644
--- a/lib/ansible/utils/module_docs_fragments/tower.py
+++ b/lib/ansible/plugins/doc_fragments/tower.py
diff --git a/lib/ansible/utils/module_docs_fragments/ucs.py b/lib/ansible/plugins/doc_fragments/ucs.py
index 4555e457ba..4555e457ba 100644
--- a/lib/ansible/utils/module_docs_fragments/ucs.py
+++ b/lib/ansible/plugins/doc_fragments/ucs.py
diff --git a/lib/ansible/utils/module_docs_fragments/url.py b/lib/ansible/plugins/doc_fragments/url.py
index d4f7fe4e95..d4f7fe4e95 100644
--- a/lib/ansible/utils/module_docs_fragments/url.py
+++ b/lib/ansible/plugins/doc_fragments/url.py
diff --git a/lib/ansible/utils/module_docs_fragments/utm.py b/lib/ansible/plugins/doc_fragments/utm.py
index 92876f50b3..92876f50b3 100644
--- a/lib/ansible/utils/module_docs_fragments/utm.py
+++ b/lib/ansible/plugins/doc_fragments/utm.py
diff --git a/lib/ansible/utils/module_docs_fragments/validate.py b/lib/ansible/plugins/doc_fragments/validate.py
index 4b5d852a89..4b5d852a89 100644
--- a/lib/ansible/utils/module_docs_fragments/validate.py
+++ b/lib/ansible/plugins/doc_fragments/validate.py
diff --git a/lib/ansible/utils/module_docs_fragments/vca.py b/lib/ansible/plugins/doc_fragments/vca.py
index 7762861070..7762861070 100644
--- a/lib/ansible/utils/module_docs_fragments/vca.py
+++ b/lib/ansible/plugins/doc_fragments/vca.py
diff --git a/lib/ansible/utils/module_docs_fragments/vmware.py b/lib/ansible/plugins/doc_fragments/vmware.py
index 6cf74348ac..6cf74348ac 100644
--- a/lib/ansible/utils/module_docs_fragments/vmware.py
+++ b/lib/ansible/plugins/doc_fragments/vmware.py
diff --git a/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py b/lib/ansible/plugins/doc_fragments/vmware_rest_client.py
index 7cdbefb8eb..7cdbefb8eb 100644
--- a/lib/ansible/utils/module_docs_fragments/vmware_rest_client.py
+++ b/lib/ansible/plugins/doc_fragments/vmware_rest_client.py
diff --git a/lib/ansible/utils/module_docs_fragments/vultr.py b/lib/ansible/plugins/doc_fragments/vultr.py
index 0f0ee72ece..0f0ee72ece 100644
--- a/lib/ansible/utils/module_docs_fragments/vultr.py
+++ b/lib/ansible/plugins/doc_fragments/vultr.py
diff --git a/lib/ansible/utils/module_docs_fragments/vyos.py b/lib/ansible/plugins/doc_fragments/vyos.py
index 661c76ebe8..661c76ebe8 100644
--- a/lib/ansible/utils/module_docs_fragments/vyos.py
+++ b/lib/ansible/plugins/doc_fragments/vyos.py
diff --git a/lib/ansible/utils/module_docs_fragments/xenserver.py b/lib/ansible/plugins/doc_fragments/xenserver.py
index af6736f331..af6736f331 100644
--- a/lib/ansible/utils/module_docs_fragments/xenserver.py
+++ b/lib/ansible/plugins/doc_fragments/xenserver.py
diff --git a/lib/ansible/utils/module_docs_fragments/zabbix.py b/lib/ansible/plugins/doc_fragments/zabbix.py
index f6030bf0e5..f6030bf0e5 100644
--- a/lib/ansible/utils/module_docs_fragments/zabbix.py
+++ b/lib/ansible/plugins/doc_fragments/zabbix.py
diff --git a/lib/ansible/plugins/loader.py b/lib/ansible/plugins/loader.py
index c6c32c8e5d..7e1236318a 100644
--- a/lib/ansible/plugins/loader.py
+++ b/lib/ansible/plugins/loader.py
@@ -633,12 +633,11 @@ _PLUGIN_FILTERS = _load_plugin_filter()
# doc fragments first
fragment_loader = PluginLoader(
'ModuleDocFragment',
- 'ansible.utils.module_docs_fragments',
- os.path.join(os.path.dirname(__file__), 'module_docs_fragments'),
- '',
+ 'ansible.plugins.doc_fragments',
+ C.DOC_FRAGMENT_PLUGIN_PATH,
+ 'doc_fragments',
)
-
action_loader = PluginLoader(
'ActionModule',
'ansible.plugins.action',
diff --git a/lib/ansible/utils/plugin_docs.py b/lib/ansible/utils/plugin_docs.py
index 6cbc50859d..1735a6c271 100644
--- a/lib/ansible/utils/plugin_docs.py
+++ b/lib/ansible/utils/plugin_docs.py
@@ -97,7 +97,7 @@ def add_fragments(doc, filename, fragment_loader):
def get_docstring(filename, fragment_loader, verbose=False, ignore_errors=False):
"""
- DOCUMENTATION can be extended using documentation fragments loaded by the PluginLoader from the module_docs_fragments directory.
+ DOCUMENTATION can be extended using documentation fragments loaded by the PluginLoader from the doc_fragments plugins.
"""
data = read_docstring(filename, verbose=verbose, ignore_errors=ignore_errors)
diff --git a/test/runner/lib/classification.py b/test/runner/lib/classification.py
index 160a797b21..f80e1c6e52 100644
--- a/test/runner/lib/classification.py
+++ b/test/runner/lib/classification.py
@@ -559,7 +559,7 @@ class PathMapper(object):
'units': 'all',
}
- if path.startswith('lib/ansible/utils/module_docs_fragments/'):
+ if path.startswith('lib/ansible/plugins/docs_fragments/'):
return {
'sanity': 'all',
}
diff --git a/test/runner/lib/sanity/ansible_doc.py b/test/runner/lib/sanity/ansible_doc.py
index a3b35d93e6..d94d24ae60 100644
--- a/test/runner/lib/sanity/ansible_doc.py
+++ b/test/runner/lib/sanity/ansible_doc.py
@@ -41,9 +41,11 @@ class AnsibleDocTest(SanityMultipleVersion):
skip_file = 'test/sanity/ansible-doc/skip.txt'
skip_modules = set(read_lines_without_comments(skip_file, remove_blank_lines=True))
+ # This should use documentable plugins from constants instead
plugin_type_blacklist = set([
# not supported by ansible-doc
'action',
+ 'doc_fragments',
'cliconf',
'filter',
'httpapi',
diff --git a/test/runner/lib/sanity/yamllint.py b/test/runner/lib/sanity/yamllint.py
index 1073fb26eb..10c5b09c3d 100644
--- a/test/runner/lib/sanity/yamllint.py
+++ b/test/runner/lib/sanity/yamllint.py
@@ -44,7 +44,7 @@ class YamllintTest(SanitySingleVersion):
[i.path for i in targets.include if os.path.splitext(i.path)[1] == '.py' and
os.path.basename(i.path) != '__init__.py' and
- i.path.startswith('lib/ansible/utils/module_docs_fragments/')],
+ i.path.startswith('lib/ansible/plugins/docs_fragments/')],
]
paths = [sorted(p) for p in paths if p]
diff --git a/test/sanity/code-smell/boilerplate.py b/test/sanity/code-smell/boilerplate.py
index 6cd9665b11..867e37b4d1 100755
--- a/test/sanity/code-smell/boilerplate.py
+++ b/test/sanity/code-smell/boilerplate.py
@@ -30,7 +30,7 @@ def main():
'lib/ansible/modules/network/panos/',
'lib/ansible/modules/network/vyos/',
'lib/ansible/modules/windows/',
- 'lib/ansible/utils/module_docs_fragments/',
+ 'lib/ansible/plugins/doc_fragments/',
'test/'
]
diff --git a/test/sanity/yamllint/yamllinter.py b/test/sanity/yamllint/yamllinter.py
index d8926e2238..5b0c1b8fa9 100755
--- a/test/sanity/yamllint/yamllinter.py
+++ b/test/sanity/yamllint/yamllinter.py
@@ -147,7 +147,7 @@ class YamlChecker(object):
for body_statement in module_ast.body:
if isinstance(body_statement, ast.Assign):
check_assignment(body_statement, module_doc_types)
- elif path.startswith('lib/ansible/utils/module_docs_fragments/'):
+ elif path.startswith('lib/ansible/plugins/docs_fragments/'):
for body_statement in module_ast.body:
if isinstance(body_statement, ast.ClassDef):
for class_statement in body_statement.body: