7.3. sphinx-graphviz#

Uitleg over de extensie sphinx-graphviz.

Met Graphviz kun je diagrammen tekenen op basis van een tekst-gebaseerde beschrijving.

7.3.1. Installatie en configuratie#

  • om graphviz te kunnen gebruiken moet de bijbehorende software (“dot” enz.) op je computer geïnstalleerd zijn.

  • om graphviz te gebruiken in Jupyter Book moet je deze als sphinx-extensie opgeven (in _config:

sphinx:
  extra_extensions:
    - sphinx_exercise
    - sphinx.ext.graphviz
  config: 
    language: nl  
    graphviz_output_format: "svg"

Het default output-formaat is PNG, maar SVG geeft een wat “strakker” resultaat.

7.3.2. Documentatie#

7.3.3. Voorbeelden#

Met Graphviz kun je diagrammen tekenen op basis van een tekst-gebaseerde beschrijving. De volgende input (“digraph” staat voor directed graph):

:::{graphviz}
:align: center
digraph G {
  rankdir=LR
  node [shape=box, color=blue]
  stap1 -> stap2 -> stap3
}
:::

geeft het volgende resultaat:

digraph G { rankdir=LR node [shape=box, color=blue] stap1 -> stap2 -> stap3 }

Nog een voorbeeld:

:::{graphviz}
:align: center
digraph G {
  node1 [label="Hello"]
  node2 [shape=box, label="World!"]
  node1 -> node2
}
:::

De default rankdir is TB (top-to-bottom); de default shape is ellipse; de default color is black.

digraph G { node1 [label="Hello"] node2 [shape=box, label="World!"] node1 -> node2 }