Skip to content

Commit ec42fff

Browse files
[#1390] Update instructions to include graphviz
1 parent c81eb27 commit ec42fff

2 files changed

Lines changed: 6 additions & 0 deletions

File tree

docs/source/Build/installOnMacOS.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,11 @@ In order to run Basilisk on macOS, the following software is necessary:
4242
#. (Optional) Get the `PyCharm <https://www.jetbrains.com/pycharm/>`__
4343
application to be able to edit python source files
4444

45+
#. (Optional, required to build docs locally) Install `Doxygen <https://www.doxygen.nl>`__ and
46+
`Graphviz <https://graphviz.org>`__ via Homebrew::
47+
48+
$ brew install doxygen graphviz
49+
4550
Install Python 3
4651
----------------
4752
To install Python 3 on macOS there are two common options:

docs/source/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ def build_supportdata_index_rst(output_file: str):
133133
]
134134

135135
graphviz_output_format = "svg"
136+
graphviz_dot = "/opt/homebrew/bin/dot"
136137

137138
# Use MathJax SVG output instead of CHTML to avoid browser/font-metric
138139
# rendering artifacts (e.g., vertically offset multi-character symbols).

0 commit comments

Comments
 (0)