minicylc

An extension for visualising simple Cylc graph strings.

.. minicylc::
   :snippet:

   foo => bar => baz

foo => bar => baz

digraph Mini_Cylc { foo -> bar baz bar -> baz }

Directives

.. minicylc::

Renders a visualisation of a simple Cylc graph.

In HTML documents this will display an animated graph, otherwise a plain graph will be displayed as an image.

:snippet: (flag)

If set a code snippet containing the graph string will also be rendered.

:size:

Sets the graphviz size attribute.

:theme:

The name of the colour theme for animation, currently supported:

demo

Active / completed tasks are blue, all other states are blank.

default

Classic Cylc7 theme.

Note

Inherits options from the digraph directive.

Configuration

Required

extensions

Must include sphinx.ext.graphviz

graphviz_output_format

Must be set to svg for animated visualisations