History

Qiyuan Gong d36e7c4ff3 [PPML] Add BIOS conf & 1 known issues for installing SGX driver (#6206 ) * Add BIOS configuration. * Add memory check for SGX, i.e., `Installed Memory = Total Memory + 2 * PRMRR`. * Add BTF issues for installing SGX driver. * Refine 2 known issue solutions.		2022-10-20 09:05:26 +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	[PPML] Add BIOS conf & 1 known issues for installing SGX driver (#6206 )	2022-10-20 09:05:26 +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

README.md

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