2.4. reStructuredText¶

2.4.1. Links¶

• RST Sphinx documentation: http://www.sphinx-doc.org/en/stable/rest.html
• RST Syntax: http://docutils.sourceforge.net/rst.html
• Important extensions: http://sphinx-doc.org/ext/todo.html

Cheatcheat:

• http://github.com/ralsina/rst-cheatsheet/raw/master/rst-cheatsheet.pdf
• http://docutils.sourceforge.net/docs/ref/rst/directives.html

2.4.2. Source¶

The source for this page is located at

• https://raw.githubusercontent.com/cloudmesh/classes/master/docs/source/lesson/doc/rst.rst

This way you can look at the source on how we create this page.

2.4.3. Sections¶

# with overline, for parts * with overline, for chapters =, for sections -, for subsections ^, for subsubsections “, for paragraphs

RST allows to specify a number of sections. You can do this with the various underlines:

*********************
Chapter
*********************
Section
=====================
Subsection
---------------------
Subsubsection
^^^^^^^^^^^^^^^^^^^^^
Paragraph
~~~~~~~~~~~~~~~~~~~~~

2.4.4. Listtable¶

.. csv-table:: Eye colors
   :header: "Name", "Firstname", "eyes"
   :widths: 20, 20, 10

   "von Laszewski", "Gregor", "gray"

2.4.5. Exceltable¶

we have integrated Excel table from http://pythonhosted.org//sphinxcontrib-exceltable/ intou our sphinx allowing the definition of more elaborate tables specified in excel. Howere the most convenient way may be to use list-tables. The documentation to list tables can be found at http://docutils.sourceforge.net/docs/ref/rst/directives.html#list-table

2.4.6. Boxes¶

.. seealso:: This is a simple **seealso** note.

.. note::  This is a **note** box.

.. warning:: note the space between the directive and the text

.. attention:: This is an **attention** box.

.. caution:: This is a **caution** box.

.. danger:: This is a **danger** box.

.. error:: This is a **error** box.

.. hint:: This is a **hint** box.

.. important:: This is an **important** box.

.. tip:: This is a **tip** box.

2.4.7. Sidebar directive¶

It is possible to create sidebar using the following code:

.. sidebar:: Sidebar Title
    :subtitle: Optional Sidebar Subtitle

    Subsequent indented lines comprise
    the body of the sidebar, and are
    interpreted as body elements.

2.4.8. Sphinx Prompt¶

.. prompt:: bash, cloudmesh$

   wget -O cm-setup.sh http://bit.ly/cloudmesh-client-xenial
   sh cm-setup.sh

wget -O cm-setup.sh http://bit.ly/cloudmesh-client-xenial
sh cm-setup.sh

2.4.9. Programm examples¶

You can include code examples and bash commands with two colons.

This is an example for python:

print ("Hallo World")

This is an example for a shell command:

$ ls -lisa

2.4.10. Hyperlinks¶

Direct links to html pages can ve done with:

`This is a link to an html page <hadoop.html>`_

Note that this page could be generated from an rst page

Links to the FG portal need to be formulated with the portal tag:

:portal:`List to FG projects </projects/all>`

In case a subsection has a link declared you can use :ref: (this is the prefered way as it can be used to point even to subsections:

:ref:`Connecting private network VMs  clusters <_s_vpn>`

A html link can be created anywhere in the document but must be unique. for example if you place:

.. _s_vpn:

in the text it will create a target to which the above link points when you click on it

2.4.11. Todo¶

.. todo:: an example