Build The Docs

The main documentation is built using jupyter-book which you can install with dev dependencies:

pip install ".[dev]"

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

python docs/examples/_convert_examples_to_notebooks.py
jupyter-book build docs/

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

Rust API Docs

To build the rust api docs you can do:

cd rust/
cargo doc --no-deps --open