The manual and examples are both built as a single sphinx site with shared dependencies. The Quantinuum-sphinx templates are used for styling.
The docs can be built locally by following these steps
- First clone this repository including the pytket-docs-theming submodule
git clone [email protected]:CQCL/pytket-docs.git --recurse-submodulesIf you use git pull inside the docs/pytket-docs-theming directory, you should be using the latest version of the theming.
- Next, install the dependencies using poetry
poetry install- Finally, run the
build-docs.shscript from the root directory.
poetry run ./build-docs.sh
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.