Field Lists

Wie bereits besprochen, sind Field Lists Sequenzen von Feldern, die wie folgt gekennzeichnet sind.

:fieldname: Field content

Sphinx erweitert das Standardverhalten von docutils für Field Lists und fügt einige zusätzliche Funktionalitäten hinzu, die in diesem Abschnitt behandelt werden.

Hinweis

Die Werte von Field Lists werden als Strings geparst. Sie können keine Python-Sammlungen wie Listen oder Wörterbücher verwenden.

Datei-weite Metadaten

Eine Field List am Anfang einer Datei wird normalerweise von docutils als docinfo geparst und auf der Seite angezeigt. In Sphinx wird jedoch eine Field List, die vor jedem anderen Markup steht, vom docinfo in die Sphinx-Umgebung als Dokumentenmetadaten verschoben und nicht in der Ausgabe angezeigt.

Hinweis

Eine Field List, die nach dem Dokumententitel erscheint, wird wie gewohnt Teil des docinfo sein und in der Ausgabe angezeigt werden.

Spezielle Metadatenfelder

Sphinx bietet im Vergleich zu docutils ein benutzerdefiniertes Verhalten für bibliografische Felder.

Derzeit werden diese Metadatenfelder erkannt:

tocdepth

Die maximale Tiefe für ein Inhaltsverzeichnis dieser Datei.

:tocdepth: 2

Hinweis

Diese Metadaten beeinflussen die Tiefe des lokalen toctree. Sie beeinflussen jedoch nicht die Tiefe des globalen toctree. Daher ändert dies nicht die Seitenleiste von Themes, die den globalen toctree verwenden.

Hinzugefügt in Version 0.4.

nocomments

Wenn gesetzt, wird die Webanwendung kein Kommentarformular für eine aus dieser Quelldatei generierte Seite anzeigen.

:nocomments:
orphan

Wenn gesetzt, werden Warnungen darüber unterdrückt, dass diese Datei nicht in ein toctree aufgenommen wurde.

:orphan:

Hinzugefügt in Version 1.0.

no-search

Deaktiviert die Volltextsuche für dieses Dokument.

:no-search:

Hinweis

Die Option :no-search: deaktiviert nur die Volltextsuche, was bedeutet, dass die Objektsuche weiterhin verfügbar ist, auch wenn :no-search: gesetzt ist.

Hinzugefügt in Version 3.0.

Geändert in Version 7.3: Die Datei-weite Metadatenoption :nosearch: wurde in :no-search: umbenannt. Der vorherige Name wurde als Alias beibehalten, wird aber in einer zukünftigen Version von Sphinx als veraltet markiert und entfernt.