cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

docs: Add note about ansible-doc (#70162)

Browse source 
ansible-doc can only parse Python modules, added a note about
this is developer guide; Fixes: #69109
This commit is contained in:
Abhijeet Kasurde 2020-06-20 00:58:02 +05:30 committed by GitHub
parent 0ef75f65d9
commit da868d9d60
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
docs/docsite/rst/dev_guide/developing_locally.rst
View file

@ -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)