Skip to content

Commit b4be8f8

Browse files
committed
docs: Mention how to build documentation
1 parent 5cc8828 commit b4be8f8

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

docs/developing.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,3 +77,19 @@ mpremote cp dist/armv6m*/emlearn_trees.mpy :emlearn_trees.mpy
7777
```
7878

7979

80+
## Building documentation
81+
82+
Make sure to have dev dependencies
83+
84+
```
85+
pip install -r requirements.dev.txt
86+
```
87+
88+
Run the Sphinx build
89+
90+
```
91+
make -C docs/ html
92+
```
93+
94+
Open the frontpage in browser `docs/_build/html/index.html`
95+

0 commit comments

Comments
 (0)