Skip to content

tradingstrategy-ai/docs

Repository files navigation

Docs build

Trading strategy documentation

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

About documentation internals

Building locally

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-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