docs/gettingstarted/writingdocs/styleguide/styleguide03.rst

   1 .. _styleguide03:
   2
   3 ******************
   4 Labels, References
   5 ******************
   6
   7 A link or reference to other paragraphs within these documents can be done with
   8 following construct.
   9
  10 In this example the reference points the label **showintcommand**. The label **styleguide03**
  11 is shown at the top of this page. A label used in this way must be above a heading or title.
  12
  13 :ref:`showintcommand` command.
  14
  15 **************
  16 External Links
  17 **************
  18
  19 An external link is done with the following construct:
  20
  21 `Sphinx Markup Constructs <http://www.sphinx-doc.org/en/stable/markup/index.html>`_
  22
  23 ******
  24 Images
  25 ******
  26
  27 Images should be placed in the directory docs/_images. They can then be referenced with
  28 following construct. This is the image created to show a pull request.
  29
  30 .. figure:: /_images/examplePullReq.png
  31    :scale: 35%
  32    :align: center