What is "graphviz_dot setting" ?

Hi

I am new to Graphviz and am trying to use it with Python's Sphinx documentation generator. I'm working on Windows 8.1.

I installed graphviz on Windows and added this to my path:

"C:\Program Files (x86)\Graphviz2.38\bin"

In my Sphinx conf.py I have:

extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.todo',
'sphinx.ext.viewcode',
'sphinx.ext.napoleon',
'sphinx.ext.graphviz'
]

but when I generate html using Sphinx I get:

pickling environment... done
checking consistency... done
preparing documents... done
WARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot setting

What is the "graphviz_dot setting" ?

I have already asked this question on the Sphinx users forum but haven't received a solution there.

Best regards

David

Open a dos shell and give the

Open a dos shell and give the command

  dot -V

If this reports the version and exits, graphviz and your path are working. In that case, there is probably something you need to set in Sphinx. You should contact someone in that community. (Or look for Preferences or Options in sphinx to see if you can find "graphviz_dot setting."

Thanks for your reply

Thanks for your reply. dot -V works as expected. Unfortunately, I can't find an answer in the Sphinx docs or community but perhaps someone will reply there in a while.

Take a look

Take a look at http://sphinx-doc.org/ext/graphviz.html. Specifically the section 

graphviz_dot

The command name with which to invoke dot. The default is 'dot'; you may need to set this to a full path if dot is not in the executable search path.

Since this setting is not portable from system to system, it is normally not useful to set it in conf.py; rather, giving it on the sphinx-build command line via the -D option should be preferable, like this:

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

 

Thanks for your answer. That

Thanks for your answer. That fixed it for me.

Recent comments