History

liangs6212 077cc9f979 Chronos: Sync file paths in doc, branch-2.0-->main (#4091 ) * change branch-2.0 to main * change branch-2.0 to main * colab and github		2022-03-10 16:00:53 +08:00
..
_build	add docs	2021-10-12 11:06:44 +08:00
image	[PPML] Refine kms-client (#4011 )	2022-02-14 13:31:04 +08:00
source	Chronos: Sync file paths in doc, branch-2.0-->main (#4091 )	2022-03-10 16:00:53 +08:00
make.bat	add docs	2021-10-12 11:06:44 +08:00
Makefile	add docs	2021-10-12 11:06:44 +08:00
README.md	add docs	2021-10-12 11:06:44 +08:00
requirements-doc.txt	remove tsfresh to solve doc building conflict for protobuf version (#4047 )	2022-02-16 15:49:09 +08:00
requirements-rtd.txt	add docs	2021-10-12 11:06:44 +08:00

README.md

Analytics-zoo-doc Documentation

To compile the documentation, run the following commands from this directory.

pip install -r requirements-doc.txt
pip install -U -r requirements-rtd.txt # important for reproducing the deployment environment
make html
open _build/html/index.html

To test if there are any build errors with the documentation, do the following.

sphinx-build -b html -d _build/doctrees source _build/html