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

describe how to link to modules or plugins (#57806)

Browse source
This commit is contained in:
Sandra McCann 2019-06-13 13:52:40 -04:00 committed by Alicia Cozine
parent e264b4126f
commit 5243cba0b2
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/docsite/rst/dev_guide/style_guide/index.rst
View file

@ -141,6 +141,17 @@ Adding internal links
The second example adds custom text for the link. The second example adds custom text for the link.
Adding links to modules and plugins
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* Module links use the module name followed by ``_module`` for the anchor.
* Plugin links use the plugin name followed by the plugin type. For example, :ref:`enable become plugin <enable_become>`).
.. code-block:: rst
:ref:`this module <this_module>``
:ref:`that connection plugin <that_connection>`
Adding local TOCs Adding local TOCs
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^