Skip to content

Commit 731e498

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

2 files changed

Lines changed: 8 additions & 1 deletion

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: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
# -- Path setup --------------------------------------------------------------
1010

1111
import datetime
12+
import shutil
1213
# If extensions (or modules to document with autodoc) are in another directory,
1314
# add these directories to sys.path here. If the directory is relative to the
1415
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -133,6 +134,8 @@ def build_supportdata_index_rst(output_file: str):
133134
]
134135

135136
graphviz_output_format = "svg"
137+
_dot_candidates = ["/opt/homebrew/bin/dot", "/usr/local/bin/dot"]
138+
graphviz_dot = shutil.which("dot") or next((p for p in _dot_candidates if os.path.exists(p)), "dot")
136139

137140
# Use MathJax SVG output instead of CHTML to avoid browser/font-metric
138141
# rendering artifacts (e.g., vertically offset multi-character symbols).
@@ -323,7 +326,6 @@ def build_supportdata_index_rst(output_file: str):
323326
# breathe_projects = {"Basilisk": "../../src/*"}
324327

325328
from glob import glob
326-
import shutil
327329

328330
class fileCrawler():
329331
def __init__(self, newFiles=False):

0 commit comments

Comments
 (0)