Skip to content
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

emphasize need to have dot (graphviz) installed #7225 #7230

Merged
merged 1 commit into from
Sep 2, 2020

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Aug 26, 2020

What this PR does / why we need it:

Contributors trying to help with documentation may be confused by this cryptic warning (which we treat as fatal as of pull request #7093):

Warning, treated as error:
WARNING: dot command 'dot' cannot be run (needed for graphviz output), check the graphviz_dot setting

make: *** [html] Error 1

Which issue(s) this PR closes:

Closes #7225

Special notes for your reviewer:

The whole "Writing Documentation" page could use a re-write but I just made a couple small edits.

Suggestions on how to test this:

Try setting up a new machine to build the guides.

Does this PR introduce a user interface change? If mockups are available, please link/include them here:

No.

Is there a release notes update needed for this change?:

No.

Additional documentation:

None.

@coveralls
Copy link

Coverage Status

Coverage remained the same at 19.535% when pulling 79825db on 7225-graphviz into 796e612 on develop.

@pdurbin pdurbin requested a review from poikilotherm August 26, 2020 18:05
Copy link
Contributor

@mheppler mheppler left a comment

Choose a reason for hiding this comment

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

👍 Looks good.

@kcondon kcondon self-assigned this Sep 2, 2020
@kcondon kcondon merged commit ff0200a into develop Sep 2, 2020
@kcondon kcondon deleted the 7225-graphviz branch September 2, 2020 19:20
@djbrooke djbrooke added this to the 5.1 milestone Sep 8, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Can't build guides: WARNING: dot command 'dot' cannot be run (needed for graphviz output)
5 participants