sphinx.ext.graphviz – Adiciona gráficos Graphviz

Adicionado na versão 0.6.

Esta extensão permite incorporar gráficos Graphviz em seus documentos.

Ele adiciona estas diretivas:

.. graphviz::

Diretiva para incorporar o código graphviz. O código de entrada para dot é fornecido como o conteúdo. Por exemplo:

.. graphviz::

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

Na saída HTML, o código será renderizado para uma imagem PNG ou SVG (veja graphviz_output_format). Na saída LaTeX, o código será renderizado em um arquivo PDF que pode ser incorporado.

Você também pode incorporar arquivos dot externos, dando o nome do arquivo como um argumento para graphviz e sem conteúdo adicional:

.. graphviz:: external.dot

Quanto a todas as referências de arquivo no Sphinx, se o nome do arquivo for absoluto, ele será considerado relativo ao diretório fonte.

Alterado na versão 1.1: Adicionado suporte para arquivos externos.

opções

:alt: alternate text (text)

O texto alternativo do gráfico. Por padrão, o código do gráfico é usado para o texto alternativo.

Adicionado na versão 1.0.

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

O alinhamento horizontal do gráfico.

Adicionado na versão 1.5.

:caption: caption of the graph (text)

A legenda do gráfico.

Adicionado na versão 1.1.

:layout: layout type of the graph (text)

O layout do gráfico (ex. dot, neato e assim por diante). Um caminho para os comandos graphviz também é permitido. Por padrão, graphviz_dot é usado.

Adicionado na versão 1.4.

Alterado na versão 2.2: Renomeado de graphviz_dot

:name: label (text)

O rótulo do gráfico.

Adicionado na versão 1.6.

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

O nome da classe do gráfico.

Adicionado na versão 2.4.

.. graph::

Diretiva para incorporação de um único gráfico não direcionado. O nome é dado como um argumento de diretiva, o conteúdo do gráfico é o conteúdo da diretiva. Esta é uma diretiva de conveniência para gerar graph <nome> { <conteúdo> }.

Por exemplo:

.. graph:: foo

   "bar" -- "baz";

Nota

O nome do gráfico é passado inalterado para o Graphviz. Se ele contiver caracteres não-alfanuméricos (por exemplo, um traço), você terá que aspas duplas.

opções

Mesmo que graphviz.

:alt: alternate text (text)

Adicionado na versão 1.0.

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

Adicionado na versão 1.5.

:caption: caption of the graph (text)

Adicionado na versão 1.1.

:layout: layout type of the graph (text)

Adicionado na versão 1.4.

Alterado na versão 2.2: Renomeado de graphviz_dot

:name: label (text)

Adicionado na versão 1.6.

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

O nome da classe do gráfico.

Adicionado na versão 2.4.

.. digraph::

Diretiva para incorporação de um único gráfico direcionado. O nome é dado como um argumento de diretiva, o conteúdo do gráfico é o conteúdo da diretiva. Esta é uma diretiva de conveniência para gerar digraph <name> { <content> }.

Por exemplo:

.. digraph:: foo

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

opções

Mesmo que graphviz.

:alt: alternate text (text)

Adicionado na versão 1.0.

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

Adicionado na versão 1.5.

:caption: caption of the graph (text)

Adicionado na versão 1.1.

:layout: layout type of the graph (text)

Adicionado na versão 1.4.

Alterado na versão 2.2: Renomeado de graphviz_dot

:name: label (text)

Adicionado na versão 1.6.

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

O nome da classe do gráfico.

Adicionado na versão 2.4.

Existem também estes valores de configuração:

graphviz_dot

O nome do comando com o qual invocar dot. O padrão é 'dot'; talvez seja necessário definir isso para um caminho completo se dot não estiver no caminho de pesquisa executável.

Como essa configuração não é portável de um sistema para outro, não é muito útil configurar no conf.py; em vez disso, use o comando do sphinx-build via -D é mais eficaz, como isso:

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

Argumentos adicionais de linha de comando para fornecer ao dot, como uma lista. O padrão é uma lista vazia. Este é o lugar certo para definir atributos globais de gráfico, nó ou borda através das opções -G, -N e -E do dot.

graphviz_output_format

O formato de saída do Graphviz ao criar arquivos HTML. Isso deve ser 'png' ou 'svg'; o padrão é 'png'. Se 'svg' for usada, para fazer com que os links de URL funcionem corretamente, um atributo target apropriado deve ser definido, como "_top" e "_blank". Por exemplo, o link no gráfico a seguir deve funcionar na saída SVG:

.. graphviz::

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

Adicionado na versão 1.0: Anteriormente, a saída sempre era PNG.