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

Document module links (#42308)

Browse source
This commit is contained in:
John R Barker 2018-07-05 12:19:09 -07:00 committed by Alicia Cozine
parent 83687ce3a2
commit 6366df700d
1 changed files with 9 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/docsite/rst/dev_guide/developing_modules_documenting.rst
View file

@ -395,7 +395,14 @@ Starting with Ansible version 2.2, all new modules are required to use imports i
Formatting functions
--------------------
These formatting functions are ``U()`` for URLs, ``I()`` for option names, ``C()`` for files and option values and ``M()`` for module names.
The formatting functions are:
* ``L()`` for Links with a heading
* ``U()`` for URLs
* ``I()`` for option names
* ``C()`` for files and option values
* ``M()`` for module names.
Module names should be specified as ``M(module)`` to create a link to the online documentation for that module.
@ -409,6 +416,7 @@ Example usage::
...
See also M(win_copy) or M(win_template).
...
Time zone names are from the L(tz database,https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
See U(https://www.ansible.com/tower) for an overview.
...
See L(IOS Platform Options guide, ../network/user_guide/platform_ios.html)