Skip to content

Commit a98bbd0

Browse files
bitkarrotthunderbiscuit
authored andcommitted
docs: add python api documentation
1 parent 58e06a9 commit a98bbd0

File tree

8 files changed

+764
-0
lines changed

8 files changed

+764
-0
lines changed

bdk-python/.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,10 @@ build/
1515

1616
testing-setup-py-simple-example.py
1717
localenvironment/
18+
venv
19+
env
20+
21+
# API docs
22+
api.rst
23+
index.rst
24+
_build/

bdk-python/README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,11 @@ python setup.py --verbose bdist_wheel
4040
```shell
4141
pip install ./dist/bdkpython-<yourversion>.whl
4242
```
43+
44+
## generate the docs
45+
46+
```shell
47+
pip3 install --requirement requirements-dev.txt
48+
python3 scripts/generate_docs.py
49+
sphinx-build -b html -W --keep-going docs/ docs/_build/html
50+
```

0 commit comments

Comments
 (0)