summaryrefslogtreecommitdiffstats
path: root/docs/gettingstarted/writingdocs/styleguide/styleguide03.rst
blob: df35643b8a26efc0f73d6493130799770480ce3c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
.. _styleguide03:

******************
Labels, References
******************

A link or reference to other paragraphs within these documents can be done with
following construct.

In this example the reference points the label **showintcommand**. The label **styleguide03**
is shown at the top of this page. A label used in this way must be above a heading or title.

:ref:`showintcommand` command.

**************
External Links
**************

An external link is done with the following construct:

`Sphinx Markup Constructs <http://www.sphinx-doc.org/en/stable/markup/index.html>`_

******
Images
******

Images should be placed in the directory docs/_images. They can then be referenced with
following construct. This is the image created to show a pull request.

.. figure:: /_images/examplePullReq.png
   :scale: 35%
   :align: center