sphinx.ext.graphviz – Ajouter des graphiques Graphviz

Added in version 0.6.

Cette extension vous permet d’intégrer Graphviz graphiques dans vos documents.

Il ajoute ces directives :

.. graphviz::

Directive pour intégrer le code de graphviz. Le code d’entrée pour « point » est donné comme contenu. Par exemple: :

.. graphviz::

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

En sortie HTML, le code sera rendu en image PNG ou SVG (voir graphviz_output_format). En sortie LaTeX, le code sera rendu dans un fichier PDF intégrable.

Vous pouvez également intégrer des fichiers de points externes, en donnant le nom du fichier en argument à :rst:rst:dir:`graphviz” et sans contenu supplémentaire: :

.. graphviz:: external.dot

Comme pour toutes les références de fichiers dans Sphinx, si le nom de fichier est absolu, il est considéré comme relatif au répertoire source.

Modifié dans la version 1.1: Ajout de la prise en charge des fichiers externes.

options

:alt: alternate text (text)

The alternate text of the graph. By default, the graph code is used to the alternate text.

Added in version 1.0.

:align: alignment of the graph (left, center or right)

The horizontal alignment of the graph.

Added in version 1.5.

:caption: caption of the graph (text)

The caption of the graph.

Added in version 1.1.

:layout: layout type of the graph (text)

The layout of the graph (ex. dot, neato and so on). A path to the graphviz commands are also allowed. By default, graphviz_dot is used.

Added in version 1.4.

Modifié dans la version 2.2: Renamed from graphviz_dot

:name: label (text)

The label of the graph.

Added in version 1.6.

:class: class names (a list of class names separated by spaces)

The class name of the graph.

Added in version 2.4.

.. graph::

Directive pour l’intégration d’un seul graphique non dirigé. Le nom est donné en argument directive, le contenu du graphique est le contenu de la directive. Ceci est une directive de commodité pour générer graph <name> { <content> }.

Pas exemple:

.. graph:: foo

   "bar" -- "baz";

Note

Le nom du graphique est transmis inchangé à Graphviz ; s’il contient des caractères non alphanumériques (p. ex. un tiret), vous devez le citer deux fois.

options

Same as graphviz.

:alt: alternate text (text)

Added in version 1.0.

:align: alignment of the graph (left, center or right)

Added in version 1.5.

:caption: caption of the graph (text)

Added in version 1.1.

:layout: layout type of the graph (text)

Added in version 1.4.

Modifié dans la version 2.2: Renamed from graphviz_dot

:name: label (text)

Added in version 1.6.

:class: class names (a list of class names separated by spaces)

The class name of the graph.

Added in version 2.4.

.. digraph::

Directive pour l’intégration d’un seul graphique orienté. Le nom est donné en argument directive, le contenu du graphique est le contenu de la directive. Ceci est une directive de commodité pour générer digraph <name> { <content> }.

Pas exemple:

.. digraph:: foo

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

options

Same as graphviz.

:alt: alternate text (text)

Added in version 1.0.

:align: alignment of the graph (left, center or right)

Added in version 1.5.

:caption: caption of the graph (text)

Added in version 1.1.

:layout: layout type of the graph (text)

Added in version 1.4.

Modifié dans la version 2.2: Renamed from graphviz_dot

:name: label (text)

Added in version 1.6.

:class: class names (a list of class names separated by spaces)

The class name of the graph.

Added in version 2.4.

There are also these config values:

graphviz_dot

Le nom de la commande avec laquelle invoquer dot. La valeur par défaut est `'dot' ; vous devrez peut-être définir un chemin complet si dot n’est pas dans le chemin de recherche exécutable.

Comme ce paramètre n’est pas portable d’un système à l’autre, il n’est normalement pas utile de le définir dans conf.py ; plutôt, le donner sur la ligne de commande :program:sphinx-build via l’option :option:`-D <sphinx-build -D>” devrait être préférable, comme ceci :

sphinx-build -M html -D graphviz_dot=C:\graphviz\bin\dot.exe . _build

graphviz_dot_args

Arguments de ligne de commande supplémentaires à donner au point, sous forme de liste. La valeur par défaut est une liste vide. C’est le bon endroit pour définir des attributs globaux de graphique, de nœud ou de bord via les options dot’s -G, -N et -E.

graphviz_output_format

Le format de sortie pour Graphviz lors de la création de fichiers HTML. Ce doit être soit 'png' ou 'svg' ; la valeur par défaut est 'png'. Si 'svg' est utilisé, pour que les liens URL fonctionnent correctement, un attribut target approprié doit être défini, tel que "_top" et "_blank". Par exemple, le lien dans le graphique suivant devrait fonctionner dans la sortie svg : :: :

.. graphviz::

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

Added in version 1.0: Auparavant, la sortie était toujours en PNG.