From da868d9d6037bdce04423f6c75dd5d3d7bf6f300 Mon Sep 17 00:00:00 2001 From: Abhijeet Kasurde Date: Sat, 20 Jun 2020 00:58:02 +0530 Subject: [PATCH] docs: Add note about ansible-doc (#70162) ansible-doc can only parse Python modules, added a note about this is developer guide; Fixes: #69109 --- 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 c05d3fcb5be..573dd69d7be 100644 --- a/docs/docsite/rst/dev_guide/developing_locally.rst +++ b/docs/docsite/rst/dev_guide/developing_locally.rst @@ -45,6 +45,10 @@ To confirm that ``my_custom_module`` is available: * type ``ansible-doc -t module my_custom_module``. You should see the documentation for that module. +.. note:: + + Currently, ``ansible-doc`` command can only parse Python modules for the module documentation. If you have module written in a different programming language other than Python, please write a documentation in Python file adjacent to module file. + To use a local module only in certain playbooks: * store it in a sub-directory called ``library`` in the directory that contains the playbook(s)