History

Jason Dai 93207fcd37 Update index.rst		2021-10-20 09:00:57 +08:00
..
_build	add docs	2021-10-12 11:06:44 +08:00
image	Add files via upload	2021-10-18 16:59:17 +08:00
source	Update index.rst	2021-10-20 09:00:57 +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	add docs	2021-10-12 11:06:44 +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