describe how to link to modules or plugins (#57806)
This commit is contained in:
parent
e264b4126f
commit
5243cba0b2
1 changed files with 11 additions and 0 deletions
|
@ -141,6 +141,17 @@ Adding internal links
|
|||
|
||||
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
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
|
|
Loading…
Reference in a new issue