Building the docs requires additional dependencies listed in ./requirements.txt
.
The build process involves conversion of Jupyter notebooks to rst
files. To facilitate this, you may need to set NB_KERNEL
environment variable to the name of a kernel on your machine (e.g. export NB_KERNEL="python3"
). To get a list of available Python kernels, run jupyter kernelspec list
.
After you're set up, run make notebooks html
from the doc
directory to convert all notebooks, generate all gallery examples, and build the documentation itself. The site will live in _build/html
.
Run make clean
to delete the built site and all intermediate files. Run make -C docstrings clean
or make -C tutorial clean
to remove intermediate files for the API or tutorial components.