Skip to content

Commit

Permalink
Document Graphviz dot requirement for building docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
tomwhite authored and mergify[bot] committed Sep 15, 2021
1 parent 7155df3 commit 19f0b1b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,6 +241,9 @@ Documentation is maintained in the RestructuredText markup language (``.rst``
files) in ``docs``. The documentation consists both of prose
and API documentation.

Building the documentation requires the Graphviz ``dot`` executable, which you
can install by following `these instructions <https://graphviz.org/download/#executable-packages>`_.

You can build the documentation locally with ``make``::

cd docs
Expand Down

0 comments on commit 19f0b1b

Please sign in to comment.