Update README to include GraphViz installation requirement #272
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sarina
force-pushed
the
update-install-instructions
branch
from
2923947 to
95aff5c
Compare
ormsbee
approved these changes
Dec 20, 2021
kdmccormick
reviewed
Dec 20, 2021
README.rst
Outdated
| To test locally in a Python virtual env, you will first need to install `GraphViz <http://graphviz.org/>`_ | ||
| and either ``dot`` on the path or | ||
| `adding options to the make call <https://groups.google.com/forum/#!topic/sphinx-users/yXgNey_0M3I>`_. | ||
| On a Mac, this can be done via `brew install graphviz`. Next run the following commands:: |
There was a problem hiding this comment.
If you don't mind adding it: on Ubuntu, it can be installed with sudo apt install graphviz
README.rst
Outdated
Comment on lines
19
to
21
| To test locally in a Python virtual env, you will first need to install `GraphViz <http://graphviz.org/>`_ | ||
| and either ``dot`` on the path or | ||
| `adding options to the make call <https://groups.google.com/forum/#!topic/sphinx-users/yXgNey_0M3I>`_. |
There was a problem hiding this comment.
The wording is a little funny here - consider splitting this into two sentences and making the tense consistent.
There was a problem hiding this comment.
I realized this is actually really only for Windows, and since generally our ecosystem doesn't support windows users I took this out. I did add in the Ubuntu command, thank you.
sarina
force-pushed
the
update-install-instructions
branch
from
95aff5c to
6578481
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I'm working with a fresh environment and found I would repeatedly run into this error:
You must install GraphViz (because the warning errors out the build). I got assistance on this issue from IQSS/dataverse#7230 and borrowed the language they used because I felt it was clear.