Documentation for Trading Strategy algorithmic trading framework and protocol. View the documentation here.
- 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
pyproject.toml is automatically pulling the master version of the packages.
To build everything from the scratch:
poetry shell
# If needed
brew install pandoc
# 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-docsThen you can open build/html/index.html in your local web browser:
open build/html/index.htmlSee Makefile for more recipes.
To update Furo SCSS changes:
make rebuild-furo clean html