Skip to content

Commit 32fbe4b

Browse files
committed
Add instructions to install Graphviz, move note below Enchant install.
1 parent 12dd5de commit 32fbe4b

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/contributing/setup-build.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,26 @@ brew install enchant
3232
sudo apt-get install enchant
3333
```
3434

35+
```{note}
36+
If you are using an M1 Mac to build the documentation, there is currently [an issue with pyenchant](https://github.com/pyenchant/pyenchant/issues/265) that throws an error that the enchant library can't be found.
37+
This happens for example if you install Python 3 with `pyenv` in the default M1 architecture (aarch64), so without following instructions to use Rosetta2 x86 emulation.
38+
A workaround until pyenchant is fixed is to run `export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib` in the terminal session before you execute `make html`.
39+
```
40+
41+
Install [Graphviz](https://graphviz.org/download/) for graph visualization.
42+
43+
**macOS**
44+
45+
```shell
46+
brew install graphviz
47+
```
48+
49+
**Ubuntu**
50+
51+
```shell
52+
sudo apt-get install graphviz
53+
```
54+
3555
Clone the Plone Documentation repository, and change your working directory into the cloned project.
3656
Then with a single command using `Makefile`, create a Python virtual environment, install project dependencies, pull in Volto documentation as a git submodule, build the docs, and view the results in a web browser by opening `/_build/html/index.html`.
3757

@@ -41,12 +61,6 @@ cd documentation
4161
make html
4262
```
4363

44-
```{note}
45-
If you are using an M1 Mac to build the documentation, there is currently [an issue with pyenchant](https://github.com/pyenchant/pyenchant/issues/265) that throws an error that the enchant library can't be found.
46-
This happens for example if you install Python 3 with `pyenv` in the default M1 architecture (aarch64), so without following instructions to use Rosetta2 x86 emulation.
47-
A workaround until pyenchant is fixed is to run `export PYENCHANT_LIBRARY_PATH=/opt/homebrew/lib/libenchant-2.dylib` in the terminal session before you execute `make html`.
48-
```
49-
5064
(setup-build-available-documentation-builds-label)=
5165

5266
## Available documentation builds

0 commit comments

Comments
 (0)