Skip to content

Commit bf4b7db

Browse files
committed
docs: add guidelines for building docs
1 parent c7b69de commit bf4b7db

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,14 @@ pip3 install ./dist/bdkpython-<yourversion>.whl --force-reinstall
3030

3131
python3 -m unittest --verbose
3232
```
33+
34+
## Build HTML API Documentation (Optional)
35+
36+
6. Generate docs
37+
7. Build HTML Documentation
38+
39+
```sh
40+
python3 ./docs/generate_docs.py
41+
42+
python3 -m sphinx -b html -W --keep-going -v docs/source docs/_build/html
43+
```

0 commit comments

Comments
 (0)