Repository navigation
Add pillow and graphviz to doc build dependencies #7793
Description
Just spent about 5 mins building the docs, only to get:
Warning, treated as error:
/Users/dstansby/matplotlib/doc/examples/pylab_examples/agg_buffer.rst:8: WARNING: Exception occurred in plotting agg_buffer
from /Users/dstansby/matplotlib/doc/mpl_examples/pylab_examples/agg_buffer.py:
Traceback (most recent call last):
File "<string>", line 13, in <module>
ImportError: No module named 'PIL'
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "/Users/dstansby/matplotlib/lib/matplotlib/sphinxext/plot_directive.py", line 525, in run_code
six.exec_(code, ns)
File "<string>", line 15, in <module>
SystemExit: Pillow must be installed to run this example
Building HTML failed.
Would be good to have pillow checked before the build starts like the other dependencies.
Activity
tacaswell commentedon Jan 10, 2017
There is https://github.com/matplotlib/matplotlib/blob/master/doc-requirements.txt which has this. I guess the docs have gotten out of date?
Should have the instruction to
pip install -r ../doc-requirements.txtsomeplace.dstansby commentedon Jan 10, 2017
Also looks like the docs need
graphvizto build too.dstansby commentedon Jan 10, 2017
Huh, odd, it definitely checked for
numpydoc,ipython, andcolorspaciouswhen I started trying to build (and force stopped the build at the beginning), but notpilloworgraphviz.NelleV commentedon Jan 14, 2017
My bad… I forgot a couple of dependencies when I added the checks early on in the documentation build.
I'll fix that.
dstansby commentedon Feb 3, 2017
Pretty sure this is fixed now.
dstansby commentedon Feb 11, 2017
At least on OSX,
graphvizis needed to build the docs, should this be added to the requirements?[-]Add pillow to doc build dependencies[/-][+]Add pillow and graphviz to doc build dependencies[/+]dopplershift commentedon Feb 11, 2017
I didn't think graphviz was pip-installable. Is the requirement documented somewhere?
NelleV commentedon Feb 11, 2017
graphvis is not pip installable.
afvincent commentedon Feb 12, 2017
I can confirm that
graphvizalso seems to be required for building the docs on a GNU/Linux system (at least on Arch). I just got a nice build failure (the same as @dstansby ) after 10 min :/.afvincent commentedon Feb 12, 2017
Huh, how isn't
graphvizpip-installable? I just genuinely triedpip install graphvizand I was returned a kindSuccessfully installed graphviz-0.5.2:). Let's see if the doc now builds. Edit: Nevermind, I did not notice that the “graphviz” from pip is simply some kind of wrapper… Sorry for the noise.For the record, I had run
pip install -r ../doc-requirements.txtbefore getting the error aboutgraphviz.dstansby commentedon Feb 13, 2017
https://pypi.python.org/pypi/graphviz/0.5.2
so I guess there's no harm in adding this to
doc-requirements.txt. Is there a way to test for graphviz before running the whole doc build though?tacaswell commentedon Feb 14, 2017
which dotwill check if the underlying binary is installed or not.story645 commentedon Apr 30, 2017
Closed in #8544 if not before.