Skip to content

Commit

Permalink
Fix debug_ldap_client doc
Browse files Browse the repository at this point in the history
Fixes `microsoft.ad.debug_ldap_client` documentation problem so that it
works with `ansible-doc` and the online plugin docs.
  • Loading branch information
jborean93 committed Sep 3, 2024
1 parent 55f8f10 commit 76efae3
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 3 deletions.
4 changes: 4 additions & 0 deletions changelogs/fragments/debug-ldap-client-doc.yml
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 5 additions & 0 deletions plugins/modules/debug_ldap_client.py
Original file line number Diff line number Diff line change
@@ -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
1 change: 0 additions & 1 deletion tests/sanity/ignore-2.15.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion tests/sanity/ignore-2.16.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 0 additions & 1 deletion tests/sanity/ignore-2.17.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 76efae3

Please sign in to comment.