Die reStructuredText-Domäne¶

Hinzugefügt in Version 1.0.

Die reStructuredText-Domäne (Name rst) bietet die folgenden Direktiven

.. rst:directive:: name¶

Beschreibt eine reStructuredText-Direktive. Der name kann ein einzelner Direktivenname oder die tatsächliche Direktivensyntax sein (..-Präfix und ::-Suffix) mit Argumenten, die unterschiedlich gerendert werden. Zum Beispiel

.. rst:directive:: foo

   Foo description.

.. rst:directive:: .. bar:: baz

   Bar description.

wird gerendert als

.. foo::¶: Foo-Beschreibung.

.. bar:: baz¶: Bar-Beschreibung.

.. rst:directive:option:: name¶

Beschreibt eine Option für eine reStructuredText-Direktive. Der name kann ein einzelner Optionsname oder ein Optionsname mit durch einen Doppelpunkt (:) getrennten Argumenten sein. Zum Beispiel

.. rst:directive:: toctree

   .. rst:directive:option:: caption: caption of ToC

   .. rst:directive:option:: glob

wird gerendert als

.. toctree::

:caption: caption of ToC

:glob

Optionen

:type: description of argument (text)¶

Beschreiben Sie den Typ des Optionswerts.

Zum Beispiel

.. rst:directive:: toctree

   .. rst:directive:option:: maxdepth
      :type: integer or no value

Hinzugefügt in Version 2.1.

.. rst:role:: name¶

Beschreibt eine reStructuredText-Rolle. Zum Beispiel

.. rst:role:: foo

   Foo description.

wird gerendert als

:foo:¶: Foo-Beschreibung.

Diese Rollen werden bereitgestellt, um auf die beschriebenen Objekte zu verweisen

:rst:dir:¶

Verweisen Sie auf Direktiven und Direktivenoptionen. Beispiele

Verwenden Sie :rst:dir:`my-directive`, um auf eine Direktive zu verweisen.
Verwenden Sie :rst:dir:`my-directive:my-option`, um auf eine Direktivenoption zu verweisen.

:rst:role:¶: Verweisen Sie auf eine Rolle. Beispiel: :rst:role:`my-role`.