sphinx-doc / sphinx

The Sphinx documentation generator
https://www.sphinx-doc.org/
Other
6.46k stars 2.1k forks source link

Handle missing graphviz apps more elegantly in output #1912

Open mulkieran opened 9 years ago

mulkieran commented 9 years ago

The graphviz extension uses the graphviz applications, specifically at least, dot to generate a graphics file from the output of other extensions, .e.g., inheritance_diagram. If dot is missing, then instead of the image, the actual dot output of the other extension is displayed in the generated html.

It would be nice if there was a pretty way of handling the missing dot app, like:

This would work well with a workflow where the dot output was generated anyhow into a separate file, and also, I think, the suggestion in #655.

GadgetSteve commented 8 years ago

One suggestion might be to allow the setting of an alternate dot tool such as one of the on-line graphviz processing tools, e.g.: http://www.webgraphviz.com/ and extending the graphviz extension to include using it if a local graphviz dot tool is not found. I personally would suggest having a configuration tag graphviz_allow_web so that the user has the option of enabling it.