History

Juntao_Luo 0f1cfd82ff Chronos: installation panel enhancement (#5588 ) * Update:installation panel enhancement Left a bug to fix and install CMD to revise. * Bugfix: Fixed a bug when using Firefox browser to use the install guide form. Fixed the bug that the table's background color may be changed by mistake on Firefox browser. * Update: update panel as comment required. * Bugfix: fixed a bug in js file that will show wrong cmd when clicking 'windows' or 'docker'. * Bugfix: fixed the bug that 'cmd' shows incorrectly when clicking 'prophet' and 'ARIMA'.		2022-09-01 21:11:59 +08:00
..
_build	add docs	2021-10-12 11:06:44 +08:00
image	Update Azure PPML docs (#5163 )	2022-07-25 12:59:34 -07:00
source	Chronos: installation panel enhancement (#5588 )	2022-09-01 21:11:59 +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	[Documentation] Add Extension nbsphinx-link (#5596 )	2022-09-01 11:54:24 +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