7.8. Sphinx style guide

7.8.1. Headlines

Example:

###################
How To: Sphinx (h1)
###################

**************
Headlines (h2)
**************

Headline (h3)
=============

Headline (h4)
-------------

Headline (h5)
^^^^^^^^^^^^^

Headline (h6)
"""""""""""""

Result:

How To: Sphinx (h1)


Headlines (h2)


Headline (h3)


Headline (h4)


Headline (h5)


Headline (h6)

7.8.2. Styles

**Bold text**
*Italic text*
``Inline literal/code``
:sup:`super`\ Script
:sub:`sub`\ Script
Bold text
Italic text
Inline literal/code
superScript
subScript

7.8.3. Bullet Lists

* Unordered item
* Unordered item

    #. Nestes ordered item
    #. Nestes ordered item

        #. Nested ordered item

* Unordered item

  • Unordered item

  • Unordered item

    1. Nestes ordered item

    2. Nestes ordered item

      1. Nested ordered item

  • Unordered item

7.8.5. Tables

+-----------------+-----------------+-----------------+
| Grid table      | Header 2        | Header 3        |
|                 |                 |                 |
+=================+=================+=================+
| Column 1        | Column 2        | Vertical        |
+-----------------+-----------------+ column          +
| Horizontal span                   | span            |
+-----------------+-----------------+-----------------+

============  ========  ========
Simple table  Header 2  Header 3
============  ========  ========
Column 1      Column 2  Column 3
Horizontal column span  ...
----------------------  --------
...           ...       ...
============  ========  ========

.. csv-table:: table title
    :header: "Header 1", "Header 2", "Header 3"
    :widths: 20, 20, 20
    :encoding: utf-8
    :header-rows: 1

    "Row 1, Column 1", "Row 1, Column 2", "Row 1, Column 3"
    "Row 2, Column 1", "Row 2, Column 2", "Row 2, Column 3"

The csv-table directive can be used to create tables from CSV files:

.. csv-table:: table title
    :header: "Header 1", "Header 2", "Header 3"
    :widths: 20, 20, 20
    :encoding: utf-8
    :header-rows: 1
    :file: table.csv

7.8.5.1. Grid table

Grid table

Header 2

Header 3

Column 1

Column 2

Vertical column span

Horizontal span

7.8.5.2. Simple table

Simple table

Header 2

Header 3

Column 1

Column 2

Column 3

Horizontal column span

…

…

…

…

7.8.5.3. CSV table

table title

Header 1

Header 2

Header 3

Row 1, Column 1

Row 1, Column 2

Row 1, Column 3

Row 2, Column 1

Row 2, Column 2

Row 2, Column 3

7.8.6. Images and Figures

Figures are images with captions. They support all image options.

.. image:: image.png
    :alt: Image alt text
    :width: 150px
    :height: 150px
    :align: center
    :target: target_

.. figure:: image.png
    :align: center
    :height: 150px
    :name: figure-name

Figure caption :figure:`figure-name` or `Example <figure-name>`_

7.8.6.1. Image

Image alt text

7.8.6.2. Figure

Figure alt text

Figure caption figure-name or Example

7.8.7. Comments

.. comment
    This is a comment

7.8.8. Directives

.. directive:: argument
    :option: value

    Directive content

7.8.9. Table of Contents

.. local table of contents. The ``:local:`` option is optional.

.. contents:: Table of Contents
    :local:
    :depth: 2

.. defines global structure and includes all sub toc-trees and tocs
    Can also be set to visible by omitting the ``:hidden:`` option

.. toc-tree:: Table of Contents
    :maxdepth: 2
    :numbered:
    :hidden:

    file.rst
    second_file
    directory/file

7.8.9.1. Table of Contents (this document)

7.8.10. Content Block Directives

7.8.10.1. .. topic:: [title]

.. topic:: Topic title

    Topic content

7.8.10.3. .. admonition:: [title]

.. admonition:: Admonition title

    Admonition content

Admonition title

Admonition content

7.8.10.4. .. attention::

.. attention::

    Attention content

Attention

Attention content

7.8.10.5. .. caution::

.. caution::

    Caution content

Caution

Caution content

7.8.10.6. .. danger::

.. danger::

    Danger content

Danger

Danger content

7.8.10.7. .. error::

.. error::

    Error content

Error

Error content

7.8.10.8. .. hint::

.. hint::

    Hint content

Hint

Hint content

7.8.10.9. .. important::

.. important::

    Important content

Important

Important content

7.8.10.10. .. note::

.. note::

    Note content

Note

Note content

7.8.10.11. .. tip::

.. tip::

    Tip content

Tip

Tip content

7.8.10.12. .. warning::

.. warning::

    Warning content

Warning

Warning content

7.8.10.13. .. seealso::

.. seealso::

    See also content

See also

See also content

7.8.10.14. .. versionadded:: [version]

.. versionadded:: 1.0

    Version added content

New in version 1.0: Version added content

7.8.10.15. .. versionchanged:: [version]

.. versionchanged:: 1.0

    Version changed content

Changed in version 1.0: Version changed content

7.8.10.16. .. deprecated:: [version]

.. deprecated:: 1.0

    Deprecated content

Deprecated since version 1.0: Deprecated content

7.8.10.17. .. math::

.. math::

    \int_{-\infty}^\infty g(x) dx = 1
\[\int_{-\infty}^\infty g(x) dx = 1\]

7.8.10.18. .. raw:: output format

.. raw:: html

    <div>Raw HTML content</div>
Raw HTML content

7.8.11. Code Examples

.. code-block:: python
    :linenos:
    :emphasize-lines: 2,3
    :caption: Code caption
    :name: code-name

    // Code example
    some_function();
    any_var = 42;

    // Do another thing
    another_function();

.. literalinclude:: index.rst
    :language: rst
    :linenos:
    :emphasize-lines: 2-5
    :dedent: 4
Code caption
1// Code example
2some_function();
3any_var = 42;
4
5// Do another thing
6another_function();

 1.. _tutorial_intro:
 2
 3Tutorials
 4#############
 5*Current status of Q1 2022*
 6
 7
 8These Tutorials guide you to understand the development process, rules and concepts do embedd your projects to the EVerest enviroment.
 9
10
11.. toctree::
12   :maxdepth: 1
13   :glob:
14   
15   */index
16   *