monjie110 / docs

Trading strategy documentaiton

Trading strategy documentation

Documentation for Trading Strategy algorithmic trading framework and protocol. View the documentation here.

About documentation internals

• The documentation is built on the top of Sphinx documentation toolchain
• Furo based theme is used (the theme has been modified)
• API documentation is generated with sphinx-autodoc-typehints
• Interactive Jupyter notebook examples are generated with nbsphinx
• The documentation is self-hosted using Caddy

Building locally

pyproject.toml is automatically pulling the master version of the packages.

To build everything from the scratch:

poetry shell
# This is a very long duration command.
# For the subsequent documenation updates,
# it is enough to run
# make html
make clean-install-and-build-local-docs

Then you can open build/html/index.html in your local web browser:

open build/html/index.html

See Makefile for more recipes.

Updating theme

See theme README.

To update Furo SCSS changes:

make rebuild-furo clean html

Community

• Trading Strategy website

• Blog

• Twitter

• Discord

• Telegram channel