User Guide Documentation (Manual + Example Notebooks)

Building the Docs

The manual and examples are both built as a single sphinx site with shared dependencies. The Quantinuum-sphinx theme is used for styling.

Note that it is recommended to have the uv package manager and the just command runner installed to build the docs.

The docs can be built locally by following these steps

1. First clone this repository including the pytket-docs-theming submodule

git clone git@github.com:Quantinuum/pytket-docs.git --recurse-submodules

If you use git pull inside the sphinx/pytket-docs-theming directory, you should be using the latest version of the theming.

2. Next, build the docs using the just build command

just build

This will execute the jupyter cells in the manual and example notebooks and show the outputs of most cells.

Some notebooks are currently excluded from execution at the moment. These notebooks are listed here.

3. Optionally, serve the html pages locally on a web server. This requires npm.

just serve