reStructuredText

reStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line program documentation (such as Python docstrings), for quickly creating simple web pages, and for standalone documents.

The primary goal of reStructuredText is to define and implement a markup syntax for use in Python docstrings and other documentation domains, that is readable and simple, yet powerful enough for non-trivial use. The intended purpose of the markup is the conversion of reStructuredText documents into useful structured data formats.

Links

• reStructuredText-Home
• Quick reStructuredText
• reStructuredText Directives

Admonitions-Directives

Von mir öfter verwendete Admonitions-Directives (Ermahnungen).

caution (Achtung, Warnung, Vorsicht)

http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions

.. caution::

  Achtung, Warnung, Vorsicht

important (Wichtig, Entscheidend)

http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions

.. important::

  Wichtig, Entscheidend

tip (Tipp)

http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions

.. tip::

  Tipp

hint (Hinweis)

http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions

.. hint::

   Hinweis

container (DIV-Container mit der angefügten Klasse)

.. container:: meine-klasse
  
   Content    

Inhaltsverzeichnis

http://docutils.sourceforge.net/docs/ref/rst/directives.html#table-of-contents

.. contents:: Inhalt
   :depth: 2
   :backlinks: none