Initial commit of Sphinx docs
Change-Id: I9fca8fb98502dffc2555f9de7f507b6f006e0e77 Signed-off-by: John DeNisco <jdenisco@cisco.com>
This commit is contained in:

committed by
Dave Barach

parent
1d65279ffe
commit
06dcd45ff8
32
docs/gettingstarted/writingdocs/styleguide/styleguide03.rst
Normal file
32
docs/gettingstarted/writingdocs/styleguide/styleguide03.rst
Normal file
@ -0,0 +1,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
|
Reference in New Issue
Block a user