Build The Docs

Build The Docs#

The documentation is built using jupyter-book V1 which you can install with pip:

pip install jupyter-book<2

Make sure to convert the examples to jupyter notebooks:

python docs/examples/_convert_examples_to_notebooks.py

Then, to build the docs, run the following command from the root of the repository:

jupyter-book build docs/

This builds the docs as .html and places them in docs/_build/html/. You can then view the docs by opening docs/_build/html/index.html in your browser.