Skip to content

Commit 28261be

Browse files
committed
add docs about building docs
1 parent 9af9b34 commit 28261be

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

docs/source/contributing/contributing.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,16 @@ Server:
196196
```
197197

198198
Then you are good to go!
199+
200+
## Building the documentation locally
201+
202+
If you only changed the documentation, you can also build the documentation locally using `sphinx` .
203+
204+
```bash
205+
#pip install -r docs/doc-requirements.txt
206+
207+
cd docs/
208+
make html
209+
```
210+
211+
Then open the file `docs/build/html/index.html` in your browser.

0 commit comments

Comments
 (0)