reStructuredText¶
Überschriften¶
Unterstreicht den Titel mit Interpunktionszeichen
=================================================
Ändert das Interpunktionszeichen für Untertitel
-----------------------------------------------
Absätze¶
Ein Absatz besteht aus einer oder mehreren Zeilen nicht eingerückten Textes.
Sie können durch Leerzeilen vom darüber und darunter liegenden Text getrennt werden.
Ein Absatz besteht aus einer oder mehreren Zeilen nicht eingerückten Textes.
Sie können durch Leerzeilen vom darüber und darunter liegenden Text getrennt
werden.
Inline-Auszeichnung¶
Kursiv, fett und vorformattiert
*Kursiv*, **fett** und ``vorformattiert``
Links¶
Externe Links¶
`Hyperlink <https://en.wikipedia.org/wiki/Hyperlink>`_ `Link`_
.. _Link: https://en.wikipedia.org/wiki/Link_(The_Legend_of_Zelda)
Bemerkung
Vor einer mit ..
beginnenden Direktive muss immer eine Leerzeile
stehen.
Interne Links¶
Stellen mit Querverweisen¶
Zu referenzierender Abschnitt¶
Um auf einen Abschnitt zu verweisen, verwendet Zu referenzierender Abschnitt.
.. _my-reference-label:
Zu referenzierender Abschnitt
.............................
Um auf einen Abschnitt zu verweisen, verwendet :ref:`my-reference-label`.
Auf Dokumente referenzieren¶
Link zur Startseite oder zu Docstrings.
Link zur :doc:`Startseite <../index>` oder zu :doc:`docstrings`.
Dokumente herunterladen¶
Link zu einem Dokument, das nicht von Sohinx gerendert werden soll, z.B. zu autodoc-examples.rst
.
Link zu einem Dokument, das nicht von Sohinx gerendert werden soll,
:abbr:`z.B. (zum Beispiel)` zu :download:`docstrings-example.rst`.
Bilder¶
.. image:: uml/activity-diagram.svg
Andere semantische Auszeichnungen¶
Dateiliste¶
/Users/NAME/python-basics
:file:`/Users/{NAME}/python-basics`
Listen¶
Nummerierte Listen¶
Erstens
Zweitens
Drittens
#. Erstens
#. Zweitens
#. Drittens
Unnummerierte Listen¶
Jeder Eintrag in einer Liste beginnt mit einem Asterisk (
*
)Listeneinträge können über mehrere Zeilen angezeigt werden, solange die Listeneinträge eingerückt bleiben.
* Jeder Eintrag in einer Liste beginnt mit einem Asterisk (``*``)
* Listeneinträge können über mehrere Zeilen angezeigt werden, solange die
Listeneinträge eingerückt bleiben.
Definitionsliste¶
- Term
Definition des Begriffs
- EIn anderer Term
… und seine Definition
Term
Definition des Begriffs
EIn anderer Term
… und seine Definition
Verschachtelte Listen¶
Listen können auch verschachtelt werden
und Unterpunkte enthalten
* Listen können auch verschachtelt werden
* und Unterpunkte enthalten
Literarische Blöcke¶
»Blockmarkierungen sehen aus wie Absätze, sind aber mit einem oder mehreren Leerzeichen eingerückt.«
»Blockmarkierungen sehen aus wie Absätze, sind aber mit einem oder mehreren
Leerzeichen eingerückt.«
Zeilenblöcke¶
| Durch das Pipe-Zeichen wird dies zu einer Zeile.
| Und dies wird eine weitere Zeile sein.
Code-Blöcke¶
Codeblöcke werden mit zwei Doppelpunkten eingeleitet und eingerückt:
import docutils
print help(docutils)
>>> print 'Aber Doctests beginnen mit ">>>" und müssen nicht eingerückt werden.'
Codeblöcke werden mit zwei Doppelpunkten eingeleitet und eingerückt::
import docutils
print help(docutils)
>>> print 'Aber Doctests beginnen mit ">>>" und müssen nicht eingerückt werden.'
Siehe auch
Tabellen¶
Spaltenüberschrift |
Spaltenüberschrift |
Spaltenüberschrift |
Spaltenüberschrift |
---|---|---|---|
Zeile 1, Spalte 1 |
Zeile 1, Spalte 2 |
Zeile 1, Spalte 3 |
Zeile 1, Spalte 4 |
Zeile 2, Spalte 1 |
Zeile 2, Spalte 2 |
Zeile 2, Spalte 3, colspan 2 |
|
Zeile 3, Spalte 1 |
Zeile 3, Spalte 2 |
Zeile 3, Spalte 3, rowspan 2 |
Zeile 4, Spalte 4 |
Zeile 5, Spalte 1 |
Zeile 5, Spalte 2 |
Zeile 5, Spalte 4 |
+--------------------+--------------------+--------------------+--------------------+
| Spaltenüberschrift | Spaltenüberschrift | Spaltenüberschrift | Spaltenüberschrift |
+====================+====================+====================+====================+
| Zeile 1, | Zeile 1, | Zeile 1, | Zeile 1, |
| Spalte 1 | Spalte 2 | Spalte 3 | Spalte 4 |
+--------------------+--------------------+--------------------+--------------------+
| Zeile 2, | Zeile 2, | Zeile 2, |
| Spalte 1 | Spalte 2 | Spalte 3, colspan 2 |
+--------------------+--------------------+--------------------+--------------------+
| Zeile 3, | Zeile 3, | Zeile 3, | Zeile 4, |
| Spalte 1 | Spalte 2 | Spalte 3, | Spalte 4 |
+--------------------+--------------------+ rowspan 2 +--------------------+
| Zeile 5, | Zeile 5, | | Zeile 5, |
| Spalte 1 | Spalte 2 | | Spalte 4 |
+--------------------+--------------------+--------------------+--------------------+
Kommentare¶
.. Ein Kommentarblock beginnt mit zwei Punkten und kann weiter eingerückt werden.