ipex-llm/docs/readthedocs
Kai Huang f98a8612c6 Add YARN tutorial to docs (#6242)
* add yarn to docs

* modify

* meet review

* modify style

* minor

* change #

* minor
2022-10-21 17:08:16 +08:00
..
_build add docs 2021-10-12 11:06:44 +08:00
image change the readthedocs theme and reorg the sections (#6056) 2022-10-18 15:35:31 +08:00
source Add YARN tutorial to docs (#6242) 2022-10-21 17:08:16 +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 change the readthedocs theme and reorg the sections (#6056) 2022-10-18 15:35:31 +08:00
requirements-rtd.txt Readthedoc: update requirements version in doc (#5181) 2022-07-25 10:09:18 +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