From 5243cba0b2e00bc383ea7bc29508fd3d23bd46fa Mon Sep 17 00:00:00 2001 From: Sandra McCann Date: Thu, 13 Jun 2019 13:52:40 -0400 Subject: [PATCH] describe how to link to modules or plugins (#57806) --- docs/docsite/rst/dev_guide/style_guide/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/docsite/rst/dev_guide/style_guide/index.rst b/docs/docsite/rst/dev_guide/style_guide/index.rst index fc1543812e..789c9d991d 100644 --- a/docs/docsite/rst/dev_guide/style_guide/index.rst +++ b/docs/docsite/rst/dev_guide/style_guide/index.rst @@ -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 `). + +.. code-block:: rst + + :ref:`this module `` + :ref:`that connection plugin ` + Adding local TOCs ^^^^^^^^^^^^^^^^^