Snippets

Note

This page contains things that are useful shortcuts for developers.

Sphinx

References

• RST Cheatsheet

Code

To display code you can use, the shorthand double colon:

Here is some code::

    def func():
        return

The default code type is Python, but you can specify other types of code:

.. code-block:: shell

   #!/bin/sh
   echo "Hello"

Headings

• # with overline, for parts

• * with overline, for chapters

• =, for sections

• -, for subsections

• ^, for subsubsections

• “, for paragraphs

Links

External links:

`Link text <https://domain.invalid/>`_

Internal links:

.. _my-reference-label:

Section to cross-reference
--------------------------

Link to this with :ref:`my-reference-label`.