Skip to content

Commit 19f0b1b

Browse files
tomwhitemergify[bot]
authored andcommitted
Document Graphviz dot requirement for building docs.
1 parent 7155df3 commit 19f0b1b

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/contributing.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,9 @@ Documentation is maintained in the RestructuredText markup language (``.rst``
241241
files) in ``docs``. The documentation consists both of prose
242242
and API documentation.
243243

244+
Building the documentation requires the Graphviz ``dot`` executable, which you
245+
can install by following `these instructions <https://graphviz.org/download/#executable-packages>`_.
246+
244247
You can build the documentation locally with ``make``::
245248

246249
cd docs

0 commit comments

Comments
 (0)