Early check for dot binary (from graphviz) when building the doc (fixes #8207) #8221

Merged
merged 1 commit into from Mar 8, 2017

Conversation

Projects
None yet
5 participants
Contributor

afvincent commented Mar 7, 2017

Fixes #8207.

The commit is shamelessly inspired from #8213.

@afvincent afvincent add early check for dot binary (from graphviz) when building the doc
a49e973

afvincent added this to the 2.0.1 (next bug fix release) milestone Mar 7, 2017

@dstansby

Looks good if tests pass!

NelleV changed the title from Early check for dot binary (from graphviz) when building the doc (fixes #8207) to [MRG+1] Early check for dot binary (from graphviz) when building the doc (fixes #8207) Mar 7, 2017

Contributor

NelleV commented Mar 7, 2017

It also look good to me, though the amount of dependencies we have in our documentation worries me. It means that new contributors struggle with something as simple as contributing documentation.

NelleV changed the title from [MRG+1] Early check for dot binary (from graphviz) when building the doc (fixes #8207) to [MRG+2] Early check for dot binary (from graphviz) when building the doc (fixes #8207) Mar 7, 2017

@NelleV

NelleV approved these changes Mar 7, 2017

Contributor

anntzer commented Mar 7, 2017

@NelleV I wonder whether we could create two mpl-testing and mpl-docs packages on conda-forge which would pull in all required dependencies, including the non-python ones (for example, graphviz is packaged by conda). Then the instructions would just be to install the corresponding package from conda.

Contributor

NelleV commented Mar 8, 2017

@anntzer I don't use conda, so I have no opinion on whether this would be useful.
In general, I do not think it is wise to rely too much on conda for a project as wide as Matplotlib: Matplotliib should be able to get contributors from non scientific python users, and conda is not widely used outside of the Python community.

An option would be to change the default for allowsphinxwarnings so that people can build the documentation with missing dependencies. That would reduce the barrier for contributions, but then it would be up to us (core contributors) to guide new contributors on fixing travis build. I do not think we are well equipped for that option.

Contributor

anntzer commented Mar 8, 2017

Alternatively, I know that imageio has been including code to download ffmpeg/avbin/freeimage at runtime (http://imageio.readthedocs.io/en/latest/envvariables.html), so that could be an option too (although it would certainly have its own issues, unless they have completely statically linked builds...).

@NelleV NelleV merged commit bb167dd into matplotlib:master Mar 8, 2017

5 checks passed

codecov/patch Coverage not affected when comparing 1d45c08...a49e973
Details
codecov/project/library 57.97% (+0.22%) compared to 1d45c08
Details
codecov/project/tests 98.58% (target 97.9%)
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Contributor

NelleV commented Mar 8, 2017

Thanks @afvincent !

afvincent deleted the afvincent:doc_early_check_for_dot branch Mar 8, 2017

QuLogic changed the title from [MRG+2] Early check for dot binary (from graphviz) when building the doc (fixes #8207) to Early check for dot binary (from graphviz) when building the doc (fixes #8207) Mar 20, 2017

@dstansby dstansby added a commit that referenced this pull request Mar 25, 2017

@NelleV @dstansby NelleV + dstansby Merge pull request #8221 from afvincent/doc_early_check_for_dot
Early check for dot binary (from graphviz) when building the doc (fixes #8207)
c8b4db8
Contributor

dstansby commented Mar 25, 2017

Backported to 2.0.x via. c8b4db8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment