50c180520e
* docs: add dynamic allocation to FAQ/known issues in docs * style: reformat the code * docs: add known_issues to _toc.yml * docs: remove known-issues.md * fix: delete unnecessary issues * fix: refine known_issue format and add barrier mode configuration. * fix: reformat known_issues.md * fix: update known_issues.md * fix: modify known_issues.md * fix: amend the wording |
||
|---|---|---|
| .. | ||
| _build | ||
| image | ||
| source | ||
| make.bat | ||
| Makefile | ||
| README.md | ||
| requirements-doc.txt | ||
| requirements-rtd.txt | ||
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