Parser API¶

Die docutils-Dokumentation beschreibt Parser wie folgt:

Der Parser analysiert das Eingabedokument und erstellt eine Baumstruktur-Repräsentation.

In Sphinx funktioniert das Parser-Modul genauso wie bei docutils. Die Parser werden von Erweiterungen mithilfe von Application-APIs bei Sphinx registriert: Sphinx.add_source_suffix() und Sphinx.add_source_parser().

Das Quelltext-Suffix ist eine Zuordnung von Dateisuffixen zu Dateitypen. Zum Beispiel wird eine .rst-Datei dem Typ 'restructuredtext' zugeordnet. Sphinx verwendet den Dateityp, um Parser aus der registrierten Liste zu finden. Bei der Suche bezieht sich Sphinx auf das Attribut Parser.supported und wählt einen Parser aus, der den Dateityp im Attribut enthält.

Benutzer können die Zuordnungen von Quelltext-Suffixen mit source_suffix wie folgt überschreiben:

# a mapping from file suffix to file types
source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

Sie sollten die von Ihrem Parser unterstützten Dateitypen angeben. Dies ermöglicht es Benutzern, ihre Einstellungen entsprechend zu konfigurieren.

Klasse sphinx.parsers.Parser[Quelle]¶

Eine Basisklasse für Quelltext-Parser.

Zusätzliche Parser sollten von dieser Klasse und nicht von docutils.parsers.Parser erben. Diese Klasse bietet Zugriff auf Kernobjekte von Sphinx; config und env.

set_application(app: Sphinx) → None[Quelle]¶

set_application wird von Sphinx aufgerufen, um app und andere Instanzvariablen zu setzen

Parameter:: app (sphinx.application.Sphinx) – Sphinx-Anwendungsobjekt

property config: Config¶: Das config-Objekt.

property env: BuildEnvironment¶: Das Umgebungsobjekt.