Skip to content

Commit abd371b

Browse files
committed
Document work around for building documentation on M1 macs where pyenchant doesn't work out of the box
1 parent a5c0d51 commit abd371b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/contributing/setup-build.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,11 @@ cd documentation
4040
make html
4141
```
4242

43+
```{note}
44+
If you are using an M1 Mac to build the documentation, there is currently an issue with pyenchant that throws an error that the enchant library can't be found. This happens for example if you installed your Python with pyenv.
45+
A work around until pyenchant is fixed is to run `export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib`
46+
in the terminal session before you execute `make html`.
47+
```
4348

4449
(setup-build-available-documentation-builds-label)=
4550

0 commit comments

Comments
 (0)