Glossar

Builder

Eine Klasse (die von Builder erbt), die geparste Dokumente entgegennimmt und eine Aktion darauf ausführt. Normalerweise übersetzen Builder die Dokumente in ein Ausgabeformat, aber es ist auch möglich, Builder zu verwenden, die z. B. nach defekten Links in der Dokumentation suchen oder Abdeckungsinformationen erstellen.

Siehe Builder für eine Übersicht über die integrierten Builder von Sphinx.

Konfigurationsverzeichnis

Das Verzeichnis, das conf.py enthält. Standardmäßig ist dies dasselbe wie das Quellverzeichnis, kann aber mit der Befehlszeilenoption -c anders gesetzt werden.

Direktive

Ein reStructuredText-Markup-Element, das es ermöglicht, einen Inhaltsblock mit besonderer Bedeutung zu kennzeichnen. Direktiven werden nicht nur von docutils bereitgestellt, sondern Sphinx und benutzerdefinierte Erweiterungen können eigene hinzufügen. Die grundlegende Syntax für Direktiven sieht wie folgt aus

.. directive-name:: argument ...
   :option: value

   Content of the directive.

Siehe Direktiven für weitere Informationen.

Dokumentenname

Da reStructuredText-Quelldateien unterschiedliche Erweiterungen haben können (manche Leute mögen .txt, manche .rst – die Erweiterung kann mit source_suffix konfiguriert werden) und verschiedene Betriebssysteme unterschiedliche Pfadtrenner haben, abstrahiert Sphinx diese: *Dokumentennamen* sind immer relativ zum Quellverzeichnis, die Erweiterung wird entfernt und Pfadtrenner werden in Schrägstriche umgewandelt. Alle Werte, Parameter und ähnliches, die sich auf „Dokumente“ beziehen, erwarten solche Dokumentennamen.

Beispiele für Dokumentennamen sind index, library/zipfile oder reference/datamodel/types. Beachten Sie, dass kein führender oder nachgestellter Schrägstrich vorhanden ist.

Domäne

Eine Domäne ist eine Sammlung von Markups (reStructuredText- Direktiven und Rollen), um zusammengehörige Objekte zu beschreiben und darauf zu verlinken, z. B. Elemente einer Programmiersprache. Direktiven- und Rollennamen in einer Domäne haben Namen wie domain:name, z. B. py:function.

Das Vorhandensein von Domänen bedeutet, dass es keine Namenskonflikte gibt, wenn eine Dokumentation auf z. B. C++- und Python-Klassen verweisen möchte. Es bedeutet auch, dass Erweiterungen, die die Dokumentation von komplett neuen Sprachen unterstützen, viel einfacher zu schreiben sind.

Weitere Informationen finden Sie unter Domänen.

Umgebung

Eine Struktur, in der Informationen über alle Dokumente unterhalb des Wurzelverzeichnisses gespeichert werden und die für Querverweise verwendet wird. Die Umgebung wird nach der Parsing-Phase "gepickelt", so dass aufeinanderfolgende Läufe nur neue und geänderte Dokumente lesen und parsen müssen.

Erweiterung

Eine benutzerdefinierte Rolle, Direktive oder ein anderer Aspekt von Sphinx, der es Benutzern ermöglicht, beliebige Aspekte des Build-Prozesses innerhalb von Sphinx zu modifizieren.

Weitere Informationen finden Sie unter Erweiterungen.

Master-Dokument
Root-Dokument

Das Dokument, das die Haupt-toctree-Direktive enthält.

Objekt

Der grundlegende Baustein der Sphinx-Dokumentation. Jede „Objekt-Direktive“ (z. B. die py:function oder die object-Direktive) erstellt einen solchen Block; und die meisten Objekte können quergereferenziert werden.

RemoveInSphinxXXXWarning

Das Feature, auf das sich die Warnung bezieht, wird in der Sphinx-XXX-Version entfernt. Es wird normalerweise durch Sphinx-Erweiterungen verursacht, die veraltete Funktionen verwenden. Siehe auch Deprecation Warnings.

Rolle

Ein reStructuredText-Markup-Element, das es ermöglicht, einen Textabschnitt zu kennzeichnen. Wie Direktiven sind Rollen erweiterbar. Die grundlegende Syntax sieht wie folgt aus: :rolename:`content`. Weitere Details finden Sie unter Inline-Markup.

Quellverzeichnis

Das Verzeichnis, das zusammen mit seinen Unterverzeichnissen alle Quelldateien für ein Sphinx-Projekt enthält.

reStructuredText

Eine leicht lesbare, was-man-sieht-ist-was-man-bekommt-Text-Markup-Syntax und ein Parser-System.