mirror of
https://github.com/aljazceru/bitfinex-api-py.git
synced 2025-12-20 23:34:21 +01:00
docs: generate docs
This commit is contained in:
committed by
Jacob Plaster
parent
3e4beb5f7e
commit
d18c4aadf1
19
docs/regenerate_docs.md
Normal file
19
docs/regenerate_docs.md
Normal 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
|
||||
```
|
||||
Reference in New Issue
Block a user