57e46c6160
* Add extension nbsphinx-link: link notebook out of the sphinx root folder to the sphinx project * Link Notebook custom.ipynb directly from python folder to the sphinx project * Link Notebook seq_and_func.ipynb directly from python folder to the sphinx project * Small title fix * Make interactive graphs visible in readthedocs webpage for seq_and_func.ipynb * Regenerate outputs for custom.ipynb and remove parts of them |
||
|---|---|---|
| .. | ||
| _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