Build-Umgebungs-API¶

class sphinx.environment.BuildEnvironment[Quelle]¶

Attribute

app¶: Referenz auf das Sphinx (Anwendungs-)Objekt.

config¶: Referenz auf das Config-Objekt.

project¶: Zielprojekt. Siehe Project.

srcdir¶: Quellverzeichnis.

doctreedir¶: Verzeichnis zum Speichern von gepickelten Doctrees.

events¶: Ein EventManager-Objekt.

found_docs¶: Eine Menge aller vorhandenen Docnames.

metadata¶: Wörterbuch, das Docnames auf „Metadaten“ abbildet (siehe Dateiweite Metadaten).

titles¶: Wörterbuch, das Docnames auf den Docutils-Knoten für ihren Haupttitel abbildet.

docname¶: Gibt den Docname des aktuell geparsten Dokuments zurück.

parser¶: Gibt den Parser zurück, der zum Parsen des aktuellen Dokuments verwendet wird.

Dokumentenbezogene Attribute

current_document¶

Temporärer Datenspeicher während des Lesens eines Dokuments.

Erweiterungen können die von env.current_document bereitgestellte Mapping-Schnittstelle verwenden, um Daten im Zusammenhang mit dem aktuellen Dokument zu speichern, sollten aber ein eindeutiges Präfix verwenden, um Namenskonflikte zu vermeiden.

Wichtig

Nur die folgenden Attribute stellen die öffentliche API dar. Der Typ selbst und alle Methoden oder anderen Attribute bleiben privat, experimentell und können ohne Vorankündigung geändert oder entfernt werden.

current_document.docname: str¶: Der Dokumentenname („docname“) für das aktuelle Dokument.

current_document.default_role: str¶: Die Standardrolle für das aktuelle Dokument. Wird durch die Direktive default-role gesetzt.

current_document.default_domain: Domain | None¶: Die Standarddomäne für das aktuelle Dokument. Wird durch die Direktive default-domain gesetzt.

current_document.highlight_language: str¶: Die Standardsprache für Syntax-Hervorhebung. Wird durch die Direktive highlight gesetzt, um den Konfigurationswert highlight_language zu überschreiben.

current_document._parser: Parser | None¶

Dieses Attribut ist experimentell und kann ohne Vorankündigung geändert werden.

Der Parser, der zum Parsen des aktuellen Dokuments verwendet wird.

Hilfsmethoden

doc2path(docname: str, base: bool = True) → _StrPath[Quelle]¶

Gibt den Dateinamen für den Dokumentennamen zurück.

Wenn base True ist, wird der absolute Pfad unter self.srcdir zurückgegeben. Wenn base False ist, wird der relative Pfad zu self.srcdir zurückgegeben.

relfn2path(filename: str | Path, docname: str | None = None) → tuple[str, str][Quelle]¶

Gibt Pfade zu einer aus einem Dokument referenzierten Datei zurück, relativ zum Dokumenten-Root und absolut.

In der Eingabe „filename“ werden absolute Dateinamen relativ zum Quellverzeichnis interpretiert, während relative Dateinamen relativ zum Verzeichnis des enthaltenden Dokuments sind.

note_dependency(filename: str | PathLike[str], *, docname: str | None = None) → None[Quelle]¶

Fügt filename als Abhängigkeit des aktuellen Dokuments hinzu.

Das bedeutet, dass das Dokument neu aufgebaut wird, wenn sich diese Datei ändert.

filename sollte absolut oder relativ zum Quellverzeichnis sein.

new_serialno(category: str = '') → int[Quelle]¶

Gibt eine fortlaufende Nummer zurück, z. B. für Indexziele.

Die Nummer ist im aktuellen Dokument eindeutig.

note_reread() → None[Quelle]¶: Fügt das aktuelle Dokument zur Liste der Dokumente hinzu, die beim nächsten Build automatisch neu gelesen werden.