8000 Added graphviz_docs to conf.py by story645 · Pull Request #16610 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

Added graphviz_docs to conf.py #16610

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 1, 2020
Merged

Added graphviz_docs to conf.py #16610

merged 1 commit into from
Mar 1, 2020

Conversation

story645
Copy link
Member
@story645 story645 commented Mar 1, 2020

PR Summary

Was having trouble getting my docs to build, build kept reporting it couldn't find graphviz_dot environment variable and only thing that seemed to fix it was setting the graphviz_dot variable in conf.py. (longer description on discourse)
Used shutil.where('dot') since that's used earlier in the file to check if graphviz is installed so it should be portable/universal. Can do something like this instead though if folks think it's a better idea:

graphviz_dot =  sys.env['GRAPHVIZ_DOT'] if sys.env['GRAPHVIZ_DOT'] else shutils.which('dot')

Copy link
Contributor
@anntzer anntzer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think sphinx mentions the environment variable in their docs?
I guess VS does weird stuff with the $PATH...

@story645
Copy link
Member Author
story645 commented Mar 1, 2020

It's mentioned in the graphviz extension but passing it in as an arg didn't work for me:
https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html#confval-graphviz_dot

@dstansby dstansby added this to the v3.3.0 milestone Mar 1, 2020
@dstansby dstansby merged commit 42fb3dd into matplotlib:master Mar 1, 2020
@story645 story645 deleted the docs branch March 1, 2020 18:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants
0