CQCL · CalMacCQ · Sep 6, 2024 · Sep 6, 2024 · Sep 6, 2024 · Sep 6, 2024
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -41,12 +41,12 @@ jobs:
         python -m pytest
     - name: Sphinx documentation build
       run: |
-        make docs
+        bash docs/build-docs.sh
     - name: Deploy to GitHub Pages
       uses: peaceiris/actions-gh-pages@v4
       if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' && matrix.deploy-gh-pages }}
       with:
         publish_branch: gh-pages
         github_token: ${{ secrets.GITHUB_TOKEN }}
-        publish_dir: docs/build/html/
+        publish_dir: docs/build/
         force_orphan: true
diff --git a/.gitignore b/.gitignore
@@ -70,6 +70,9 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/pyproject.toml
+docs/poetry.lock
+docs/build
 
 # PyBuilder
 .pybuilder/

diff --git a/.gitmodules b/.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
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/README.md b/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).
diff --git a/docs/build-docs.sh b/docs/build-docs.sh
@@ -0,0 +1,20 @@
+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
diff --git a/docs/source/index.rst → docs/index.rst b/docs/source/index.rst → docs/index.rst
diff --git a/docs/install.sh b/docs/install.sh
@@ -0,0 +1,9 @@
+
+# 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.
diff --git a/docs/source/modules.rst → docs/modules.rst b/docs/source/modules.rst → docs/modules.rst
diff --git a/docs/pytket-docs-theming b/docs/pytket-docs-theming
diff --git a/docs/source/pytket.phir.rebasing.rst → docs/pytket.phir.rebasing.rst b/docs/source/pytket.phir.rebasing.rst → docs/pytket.phir.rebasing.rst
diff --git a/docs/source/pytket.phir.rst → docs/pytket.phir.rst b/docs/source/pytket.phir.rst → docs/pytket.phir.rst
diff --git a/docs/source/pytket.phir.sharding.rst → docs/pytket.phir.sharding.rst b/docs/source/pytket.phir.sharding.rst → docs/pytket.phir.sharding.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py