From 82e5d03bdb6ebff0d8548a5d78296a6c96c8ea32 Mon Sep 17 00:00:00 2001 From: Michael Ritsema Date: Thu, 2 Jul 2020 17:23:37 -0500 Subject: [PATCH] Suggest ansible ad-hoc command while developing module (#70308) If a local module has no documentation, the doc command will fail without any hints of what is wrong. Add another way to confirm the presence of a local module. * Update docs/docsite/rst/dev_guide/developing_locally.rst Co-authored-by: Abhijeet Kasurde --- docs/docsite/rst/dev_guide/developing_locally.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/docsite/rst/dev_guide/developing_locally.rst b/docs/docsite/rst/dev_guide/developing_locally.rst index 573dd69d7be..215240e93a0 100644 --- a/docs/docsite/rst/dev_guide/developing_locally.rst +++ b/docs/docsite/rst/dev_guide/developing_locally.rst @@ -43,6 +43,10 @@ Once you save your module file in one of these locations, Ansible will load it a To confirm that ``my_custom_module`` is available: +* type ``ansible localhost -m my_custom_module``. You should see the output for that module. + +or + * type ``ansible-doc -t module my_custom_module``. You should see the documentation for that module. .. note::