internet/community.general
3
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2026-05-07 05:42:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

adds stub API docs in a single file (#46663)

Browse Source 
* adds stub API docs in a single file
This commit is contained in:
Alicia Cozine
2018-10-11 09:15:24 -05:00
committed by Sandra McCann
parent e1cfc2500c
commit 9764f32513
11 changed files with 118 additions and 612 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/docsite/rst/dev_guide/debugging.rst
View File

@@ -110,11 +110,11 @@ When you look into the debug_dir you'll see a directory structure like this::
* The :file:`ansible` directory contains code from
:mod:`ansible.module_utils` that is used by the module. Ansible includes
files for any :`module:`ansible.module_utils` imports in the module but not
files for any :mod:`ansible.module_utils` imports in the module but not
any files from any other module. So if your module uses
:mod:`ansible.module_utils.url` Ansible will include it for you, but if
your module includes :mod:`requests` then you'll have to make sure that
the python requests library is installed on the system before running the
your module includes `requests <http://docs.python-requests.org/en/master/api/>`_ then you'll have to make sure that
the python `requests library <https://pypi.org/project/requests/>`_ is installed on the system before running the
module. You can modify files in this directory if you suspect that the
module is having a problem in some of this boilerplate code rather than in
the module code you have written.
@@ -139,7 +139,7 @@ module file and test that the real module works via :command:`ansible` or
The wrapper provides one more subcommand, ``excommunicate``. This
subcommand is very similar to ``execute`` in that it invokes the exploded
module on the arguments in the :file:`args`. The way it does this is
different, however. ``excommunicate`` imports the :func:`main`
different, however. ``excommunicate`` imports the ``main``
function from the module and then calls that. This makes excommunicate
execute the module in the wrapper's process. This may be useful for
running the module under some graphical debuggers but it is very different