ipex-llm/docs/readthedocs
2022-06-30 12:59:31 +08:00
..
_build add docs 2021-10-12 11:06:44 +08:00
image Azure PPML documentation (#4675) 2022-06-07 08:20:24 -07:00
source update tpch doc (#4979) 2022-06-30 12:59:31 +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 Update Readme (#4957) 2022-06-28 09:27:40 +08:00
requirements-doc.txt Add Nano PyTorch API Doc (#4730) 2022-06-08 17:45:24 +08:00
requirements-rtd.txt add docs 2021-10-12 11:06:44 +08:00

BigDL 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