Syntax help
This is a cheat-sheet for writing the documentation. It is only for internal use. All the following examples are for using reStructuredText instead of Markdown.
Links
`link text <http://google.com>`_
Will generate the following url:
Headers
Innhold restructured text 1
*****************************
Innhold restructured text 2
=============================
Innhold restructured text 3
-----------------------------
Innhold restructured text 4
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Admonitions
See more about admonitions here
Example admonitions
.. CAUTION::
Caution message
.. DANGER::
Danger zone!
.. NOTE::
Important note!
.. TIP::
Just a tip!
Caution
Caution message
Danger
Danger zone!
Note
Important note!
Tip
Just a tip!
References
To reference a chapter anywhere in the documentation, add a label over the heading:
.. _my-reference-label:
Section to cross-reference
--------------------------
This is the text of the section.
It refers to the section itself, see :ref:`my-reference-label`.
Tip
Always use underscore, _, first in the reference, but never when you use the reference.
Tabs
Tabs are used via an extension and how to use can be found here.
The different tabs are tab, group-tab and code-tab.
.. tabs::
.. tab:: Apples
Apples are green, or sometimes red.
.. tab:: Pears
Pears are green.
Tip
The different tabs are tab, group-tab and code-tab. With group-tab, all examples changes tab at the same time. code-tab is self explanatory, but note that it behaves like group-tab.
Example tab
Apples are green, or sometimes red.
Pears are green.
Oranges are orange.
Code snippets
.. code-block:: language
Some code here ...
Numbered lists
3. First numbered item starts with three.
4. The next numbered item, four.
#. Auto numbering. Will be 5.
Will generate the following list:
First numbered item starts with three.
The next numbered item, four.
Auto numbering. Will be 5.
Footnotes
A footnote can be created:
I have something to say [#footnoteWithUniqueName]_.
and used like so:
.. rubric:: Footnotes
.. [#footnoteWithUniqueName] Some extra important information!
Example footnote
I have something to say [1].
Footnotes
Images
Images can be added by putting an image in the images-folder and using the following code for an image:
.. |example-image| image:: images/exampledocimage.png
:alt: alternate text
:align: right
Tip
Please add the image reference to the bottom of the file. It makes the file so much easier to read.
Then, just use |example-image|
where you want the image to be inserted.
You can also specify more image tags:
:height: 100px
:width: 200 px
:scale: 50 %
:alt: alternate text
:align: right