Platzhalter

Sphinx unterscheidet die folgenden Platzhaltervariablen:

:envvar:

Umgebungsvariable, die auch einen Verweis auf die passende envvar-Direktive erzeugt, falls sie existiert.

:file:

Der Name einer Datei oder eines Verzeichnisses. Geschweifte Klammern können verwendet werden, um z.B. einen variablen Teil anzugeben:

… is installed in :file:`/usr/lib/python3.{x}/site-packages` …

In der generierten HTML-Dokumentation wird das x mit em .pre besonders ausgezeichnet und kursiv dargestellt, um zu zeigen, dass es durch die spezifische Python-Version ersetzt werden soll.

:makevar:

Der Name einer make-Variable

:samp:

Textbeispiel, wie z.B. Code, innerhalb dessen geschweifte Klammern verwendet werden können, um einen variablen Teil anzuzeigen, wie in file oder in :samp:`print 1+{VARIABLE}`.

Ab Sphinx≥1.8 können geschweifte Klammern mit einem Backslash (\) angezeigt werden.

Bemerkung

:content:

Diese Rolle hat standardmäßig keine besondere Bedeutung. Ihr könnt sie daher für alles Mögliche zu verwenden, z.B. auch für Variablennamen.

Siehe auch