From 716a99e95bc0f296f8a113b5a4e3caeca51ca87e Mon Sep 17 00:00:00 2001 From: Jordan Borean Date: Wed, 4 Sep 2024 06:00:07 +1000 Subject: [PATCH] Fix debug_ldap_client doc (#154) Fixes `microsoft.ad.debug_ldap_client` documentation problem so that it works with `ansible-doc` and the online plugin docs. --- changelogs/fragments/debug-ldap-client-doc.yml | 4 ++++ plugins/modules/debug_ldap_client.py | 5 +++++ tests/sanity/ignore-2.15.txt | 1 - tests/sanity/ignore-2.16.txt | 1 - tests/sanity/ignore-2.17.txt | 1 - 5 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 changelogs/fragments/debug-ldap-client-doc.yml create mode 100644 plugins/modules/debug_ldap_client.py diff --git a/changelogs/fragments/debug-ldap-client-doc.yml b/changelogs/fragments/debug-ldap-client-doc.yml new file mode 100644 index 0000000..d72c808 --- /dev/null +++ b/changelogs/fragments/debug-ldap-client-doc.yml @@ -0,0 +1,4 @@ +bugfixes: + - >- + Fix ``microsoft.ad.debug_ldap_client`` documentation problem so it appears in the ``ansible-doc`` plugin list and + online documentation. diff --git a/plugins/modules/debug_ldap_client.py b/plugins/modules/debug_ldap_client.py new file mode 100644 index 0000000..cb5946b --- /dev/null +++ b/plugins/modules/debug_ldap_client.py @@ -0,0 +1,5 @@ +#!/usr/bin/python +# Copyright: (c) 2023, Ansible Project +# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt) + +# This is a stub to get the docs working, the implementation is an action plugin diff --git a/tests/sanity/ignore-2.15.txt b/tests/sanity/ignore-2.15.txt index 67111f0..487788b 100644 --- a/tests/sanity/ignore-2.15.txt +++ b/tests/sanity/ignore-2.15.txt @@ -1,4 +1,3 @@ -plugins/action/debug_ldap_client.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain_child.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain_controller.py action-plugin-docs # ansible-test is ignoring sidecar docs diff --git a/tests/sanity/ignore-2.16.txt b/tests/sanity/ignore-2.16.txt index 67111f0..487788b 100644 --- a/tests/sanity/ignore-2.16.txt +++ b/tests/sanity/ignore-2.16.txt @@ -1,4 +1,3 @@ -plugins/action/debug_ldap_client.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain_child.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain_controller.py action-plugin-docs # ansible-test is ignoring sidecar docs diff --git a/tests/sanity/ignore-2.17.txt b/tests/sanity/ignore-2.17.txt index 67111f0..487788b 100644 --- a/tests/sanity/ignore-2.17.txt +++ b/tests/sanity/ignore-2.17.txt @@ -1,4 +1,3 @@ -plugins/action/debug_ldap_client.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain_child.py action-plugin-docs # ansible-test is ignoring sidecar docs plugins/action/domain_controller.py action-plugin-docs # ansible-test is ignoring sidecar docs