OpenDeltaMirror/docs
TommyWang a25fb1b2aa fix doc build 2022-11-21 15:31:55 +00:00
..
source fix doc build 2022-11-21 15:31:55 +00:00
Makefile first commit 2022-02-14 21:19:03 +08:00
make.bat first commit 2022-02-14 21:19:03 +08:00
readme.md first commit 2022-02-14 21:19:03 +08:00
requirements.txt add doc requirements 2022-11-21 05:22:27 +00:00

readme.md

OpenDelta Documentation

To build this doc locally, please firstly install sphinx packages.

pip install sphinx
pip install sphinx_rtd_theme
pip install sphinx_copybutton
pip install sphinx_toolbox
pip install myst_parser

Then install opendelta either from source, or from pip. After that,

cd docs
make html

Then open the generated docs/build/html/index.html in your local browser.