docs: generate docs

This commit is contained in:
JacobPlaster
2019-10-09 10:41:36 +01:00
committed by Jacob Plaster
parent 3e4beb5f7e
commit d18c4aadf1
3 changed files with 757 additions and 0 deletions

19
docs/regenerate_docs.md Normal file
View File

@@ -0,0 +1,19 @@
For development purposes, these are the commands used to generate the doc files.
Install pydocmd:
```
pip3 install pydoc-markdown
```
Generate REST V2 docs:
```
pydocmd simple bfxapi bfxapi.client+ bfxapi.rest.bfx_rest.BfxRest+ > ./docs/rest_v2.md
```
Generate Websocket V2 docs:
```
pydocmd simple bfxapi bfxapi.client+ bfxapi.websockets.bfx_websocket.BfxWebsocket+ > ./docs/ws_v2.md
```