Die Standard-Domäne

Hinzugefügt in Version 1.0.

Die sogenannte „Standard“-Domäne sammelt alle Auszeichnungen, die keine eigene Domäne rechtfertigen. Ihre Direktiven und Rollen sind nicht mit einem Domänennamen präfigiert.

Die Standard-Domäne ist auch der Ort, an dem benutzerdefinierte Objektbeschreibungen, die über die add_object_type() API hinzugefügt werden, platziert werden.

Es gibt eine Reihe von Direktiven, die die Dokumentation von Kommandozeilenprogrammen ermöglichen

.. option:: name args, name args, ...

Beschreibt ein Kommandozeilenargument oder einen Schalter. Optionsargumentnamen sollten in spitzen Klammern eingeschlossen sein. Beispiele

.. option:: dest_dir

   Destination directory.

.. option:: -m <module>, --module <module>

   Run a module as a script.

Die Direktive erstellt Querverweisziele für die angegebenen Optionen, die durch die option Rolle referenziert werden können (im Beispiel würden Sie etwas wie :option:`dest_dir`, :option:`-m` oder :option:`--module` verwenden).

Geändert in Version 5.3: Man kann inklusive eines Optionswertes Querverweise erstellen: :option:`--module=foobar`, ,``:option:–module[=foobar]`` oder :option:`--module foobar`.

Verwenden Sie option_emphasise_placeholders für die Verarbeitung des „variablen Teils“ eines Literaltextes (ähnlich der samp Rolle).

cmdoption ist ein veralteter Alias für die option Direktive.

.. confval:: name

Hinzugefügt in Version 7.4.

Beschreibt einen Konfigurationswert oder eine Einstellung, die der dokumentierte Code oder das Programm verwendet oder definiert. Referenzierbar durch die confval Rolle.

:type: (text)

Beschreibt den Typ des Konfigurationswerts. Dies ist optional und wird, wenn angegeben, als reStructuredText interpretiert.

:default: (text)

Beschreibt den Standardwert des Konfigurationswerts. Dies ist optional und wird, wenn angegeben, als reStructuredText interpretiert.

Beispiel

.. confval:: the_answer
   :type: ``int`` (a *number*)
   :default: **42**

   This is a setting that controls the value of the answer.

wird wie folgt gerendert

the_answer
Typ:
int (eine Zahl)
Standard:
42

Dies ist eine Einstellung, die den Wert der Antwort steuert.

.. envvar:: name

Beschreibt eine Umgebungsvariable, die der dokumentierte Code oder das Programm verwendet oder definiert. Referenzierbar durch die envvar Rolle.

.. program:: name

Wie die py:currentmodule Direktive erzeugt diese Direktive keine Ausgabe. Stattdessen benachrichtigt sie Sphinx, dass alle nachfolgenden option Direktiven Optionen für das Programm namens name dokumentieren.

Wenn Sie program verwenden, müssen Sie die Referenzen in Ihren option Rollen nach dem Programmnamen qualifizieren, also wenn Sie die folgende Situation haben

.. program:: rm

.. option:: -r

   Work recursively.

.. program:: svn

.. option:: -r <revision>

   Specify the revision to work upon.

dann würde :option:`rm -r` sich auf die erste Option beziehen, während :option:`svn -r` sich auf die zweite beziehen würde.

Wenn None an das Argument übergeben wird, setzt die Direktive den aktuellen Programmnamen zurück.

Der Programmnamen kann Leerzeichen enthalten (falls Sie Unterbefehle wie svn add und svn commit separat dokumentieren möchten).

Hinzugefügt in Version 0.5.

Es gibt auch eine sehr allgemeine Objektbeschreibungsdirektive, die an keine Domäne gebunden ist

.. describe:: text
.. object:: text

Diese Direktive erzeugt die gleiche Formatierung wie die spezifischen, die von Domänen bereitgestellt werden, erstellt aber keine Indexeinträge oder Querverweisziele. Beispiel

.. describe:: PAPER

   You can set this variable to select a paper size.