sphinx.ext.graphviz – Graphviz-Diagramme hinzufügen

Hinzugefügt in Version 0.6.

Diese Erweiterung ermöglicht es Ihnen, Graphviz-Diagramme in Ihre Dokumente einzubetten.

Sie fügt diese Direktiven hinzu

.. graphviz::

Direktive zum Einbetten von Graphviz-Code. Der Eingabecode für dot wird als Inhalt angegeben. Zum Beispiel:

.. graphviz::

   digraph foo {
      "bar" -> "baz";
   }

In der HTML-Ausgabe wird der Code in ein PNG- oder SVG-Bild gerendert (siehe graphviz_output_format). In der LaTeX-Ausgabe wird der Code in eine einbettbare PDF-Datei gerendert.

Sie können auch externe Dot-Dateien einbetten, indem Sie den Dateinamen als Argument für graphviz angeben und keinen zusätzlichen Inhalt.

.. graphviz:: external.dot

Wie bei allen Dateireferenzen in Sphinx gilt: Wenn der Dateiname absolut ist, wird er relativ zum Quellverzeichnis behandelt.

Geändert in Version 1.1: Unterstützung für externe Dateien hinzugefügt.

Optionen

:alt: Alternativtext (Text)

Der Alternativtext des Diagramms. Standardmäßig wird der Diagrammcode für den Alternativtext verwendet.

Hinzugefügt in Version 1.0.

:align: Ausrichtung des Diagramms (links, mitte oder rechts)

Die horizontale Ausrichtung des Diagramms.

Hinzugefügt in Version 1.5.

:caption: Beschriftung des Diagramms (Text)

Die Beschriftung des Diagramms.

Hinzugefügt in Version 1.1.

:layout: Layouttyp des Diagramms (Text)

Das Layout des Diagramms (z. B. dot, neato und so weiter). Ein Pfad zu den Graphviz-Befehlen ist ebenfalls zulässig. Standardmäßig wird graphviz_dot verwendet.

Hinzugefügt in Version 1.4.

Geändert in Version 2.2: Umbenannt von graphviz_dot

:name: Label (Text)

Das Label des Diagramms.

Hinzugefügt in Version 1.6.

:class: Klassenamen (eine Liste von durch Leerzeichen getrennten Klassennamen)

Der Klassenname des Diagramms.

Hinzugefügt in Version 2.4.

.. graph::

Direktive zum Einbetten eines einzelnen ungerichteten Diagramms. Der Name wird als Direktivenargument angegeben, der Inhalt des Diagramms ist der Direktiveninhalt. Dies ist eine Komfortdirektive zur Generierung von graph <name> { <inhalt> }.

Zum Beispiel

.. graph:: foo

   "bar" -- "baz";

Hinweis

Der Diagrammname wird unverändert an Graphviz übergeben. Wenn er nicht-alphanumerische Zeichen (z. B. einen Bindestrich) enthält, müssen Sie ihn in Anführungszeichen setzen.

Optionen

Dasselbe wie graphviz.

:alt: Alternativtext (Text)

Hinzugefügt in Version 1.0.

:align: Ausrichtung des Diagramms (links, mitte oder rechts)

Hinzugefügt in Version 1.5.

:caption: Beschriftung des Diagramms (Text)

Hinzugefügt in Version 1.1.

:layout: Layouttyp des Diagramms (Text)

Hinzugefügt in Version 1.4.

Geändert in Version 2.2: Umbenannt von graphviz_dot

:name: Label (Text)

Hinzugefügt in Version 1.6.

:class: Klassenamen (eine Liste von durch Leerzeichen getrennten Klassennamen)

Der Klassenname des Diagramms.

Hinzugefügt in Version 2.4.

.. digraph::

Direktive zum Einbetten eines einzelnen gerichteten Diagramms. Der Name wird als Direktivenargument angegeben, der Inhalt des Diagramms ist der Direktiveninhalt. Dies ist eine Komfortdirektive zur Generierung von digraph <name> { <inhalt> }.

Zum Beispiel

.. digraph:: foo

   "bar" -> "baz" -> "quux";

Optionen

Dasselbe wie graphviz.

:alt: Alternativtext (Text)

Hinzugefügt in Version 1.0.

:align: Ausrichtung des Diagramms (links, mitte oder rechts)

Hinzugefügt in Version 1.5.

:caption: Beschriftung des Diagramms (Text)

Hinzugefügt in Version 1.1.

:layout: Layouttyp des Diagramms (Text)

Hinzugefügt in Version 1.4.

Geändert in Version 2.2: Umbenannt von graphviz_dot

:name: Label (Text)

Hinzugefügt in Version 1.6.

:class: Klassenamen (eine Liste von durch Leerzeichen getrennten Klassennamen)

Der Klassenname des Diagramms.

Hinzugefügt in Version 2.4.

Es gibt auch diese Konfigurationswerte

graphviz_dot
Typ:
str
Standard:
'dot'

Der Befehlsname, mit dem dot aufgerufen wird. Möglicherweise müssen Sie diesen auf einen vollständigen Pfad setzen, wenn dot nicht im ausführbaren Suchpfad enthalten ist.

Da diese Einstellung nicht systemübergreifend portabel ist, ist es normalerweise nicht sinnvoll, sie in conf.py festzulegen; vielmehr ist es vorzuziehen, sie auf der sphinx-build-Kommandozeile über die Option -D anzugeben, wie zum Beispiel:

sphinx-build -M html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build
graphviz_dot_args
Typ:
Sequenz[str]
Standard:
()

Zusätzliche Kommandozeilenargumente, die an dot übergeben werden sollen, als Liste. Dies ist der richtige Ort, um globale Diagramm-, Knoten- oder Kanteneigenschaften über die -G, -N und -E Optionen von dot festzulegen.

graphviz_output_format
Typ:
| Standard:
'png'

Das Ausgabeformat für Graphviz beim Erstellen von HTML-Dateien. Dies muss entweder 'png' oder 'svg' sein. Wenn 'svg' verwendet wird, muss ein geeignetes target-Attribut gesetzt werden, z. B. "_top" und "_blank", damit die URL-Links ordnungsgemäß funktionieren. Zum Beispiel sollte der Link im folgenden Diagramm in der SVG-Ausgabe funktionieren.

.. graphviz::

     digraph example {
         a [label="sphinx", href="https://sphinx-doc.de/", target="_top"];
         b [label="other"];
         a -> b;
     }

Hinzugefügt in Version 1.0: Zuvor war die Ausgabe immer PNG.