docs: use pytket-docs-theming submodule

.gitignore

@@ -14,3 +14,7 @@ pytket/extensions/cutensornet/_metadata.py
 result
 .direnv
 .envrc
+.venv
+docs/pyproject.toml
+docs/poetry.lock
+

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "docs/pytket-docs-theming"]
+	path = docs/pytket-docs-theming
+	url = https://github.com/CQCL/pytket-docs-theming.git
+	branch = main

docs/README.md

@@ -0,0 +1,5 @@
+# Building the docs
+
+The docs are built by using the [pytket-docs-theming](https://github.com/CQCL/pytket-docs-theming/) repository as a git submodule. If there are issues with the docs build, feel free to open an issue or pull request there.
+
+For instructions on how to build the docs, take a look at the [extensions README](https://github.com/CQCL/pytket-docs-theming/blob/main/extensions/README.md).

docs/build-docs.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+rm -rf build/
+
+# Move theming elements into the docs folder
+cp -R pytket-docs-theming/_static .
+cp -R pytket-docs-theming/quantinuum-sphinx .
+cp pytket-docs-theming/conf.py .
+
+# Get the name of the project
+EXTENSION_NAME="$(basename "$(dirname `pwd`)")"
+
+# Correct github link in navbar
+sed -i '' 's#CQCL/tket#CQCL/'$EXTENSION_NAME'#' _static/nav-config.js
+
+# Build the docs. Ensure we have the correct project title.
+sphinx-build -b html -D html_title="$EXTENSION_NAME" . build 
+
+# Remove copied files. This ensures reusability.
+rm -r _static 
+rm -r quantinuum-sphinx
+rm conf.py

docs/intro.txt → docs/index.rst

@@ -31,3 +31,9 @@ This will include the necessary dependencies such as CUDA toolkit. Then, to inst
 .. toctree::
     api.rst
     changelog.rst
+
+.. toctree::
+   :caption: Useful links
+
+   Issue tracker <https://github.com/CQCL/pytket-cutensornet/issues>
+   PyPi <https://pypi.org/project/pytket-cutensornet/>

docs/install.sh

@@ -0,0 +1,8 @@
+# Copy over poetry dependencies from theming repository
+cp pytket-docs-theming/extensions/pyproject.toml .
+cp pytket-docs-theming/extensions/poetry.lock .
+
+# Install the docs dependencies. Creates a .venv directory in docs
+poetry install
+
+# NOTE: Editable wheel should be installed separately.