Environment Collector API¶

class sphinx.environment.collectors.EnvironmentCollector[Quelle]¶

Ein EnvironmentCollector ist ein spezifischer Datensammler für jedes Dokument.

Er sammelt Daten und speichert sie in der BuildEnvironment als Datenbank. Beispiele für spezifische Daten sind Bilder, Download-Dateien, Abschnittstitel, Metadaten, Indexeinträge und Toctrees usw.

Hinweis

Diese Klasse umschließt im Wesentlichen eine Untermenge von Sphinx-Event-Callbacks.

clear_doc(app: Sphinx, env: BuildEnvironment, docname: str) → None[Quelle]¶

Entfernt angegebene Daten eines Dokuments.

Diese Methode wird beim Entfernen des Dokuments aufgerufen.

Siehe auch

env-purge-doc

get_outdated_docs(app: Sphinx, env: BuildEnvironment, added: set[str], changed: set[str], removed: set[str]) → list[str][Quelle]¶

Gibt eine Liste von Docnames zurück, die neu gelesen werden müssen.

Diese Methode wird vor dem Lesen der Dokumente aufgerufen.

Siehe auch

env-get-outdated

get_updated_docs(app: Sphinx, env: BuildEnvironment) → list[str][Quelle]¶

Gibt eine Liste von Docnames zurück, die neu gelesen werden müssen.

Diese Methode wird nach dem Lesen aller Dokumente aufgerufen.

Siehe auch

env-get-updated

merge_other(app: Sphinx, env: BuildEnvironment, docnames: Set[str], other: BuildEnvironment) → None[Quelle]¶: Fügt angegebene Daten, die sich auf Docnames beziehen, aus einem anderen BuildEnvironment-Objekt zusammen, das von einem Subprozess bei parallelen Builds stammt.

Siehe auch

env-merge-info

process_doc(app: Sphinx, doctree: nodes.document) → None[Quelle]¶

Verarbeitet ein Dokument und sammelt daraus spezifische Daten.

Diese Methode wird aufgerufen, nachdem das Dokument gelesen wurde.

Siehe auch

doctree-read