Files
bitfinex-api-py/docs/regenerate_docs.md
2019-10-10 11:47:29 +01:00

395 B

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