Gh pages deploy (#9)

* Change gh-pages deploy

* Alter workflow

---------

Co-authored-by: Thomas Pinder <[email protected]>

Author: thomaspinder

.github/workflows/docs.yml

@@ -36,7 +36,7 @@ jobs:
         uses: pypa/hatch@install
 
       - name: Build and deploy the documentation
-        run: hatch run docs:build
+        run: hatch run docs:deploy
 
       - name: Deploy Page 🚀
         uses: JamesIves/[email protected]

.github/workflows/test_docs.yml

@@ -1,4 +1,4 @@
-name: Build Documentation
+name: Test Documentation
 
 on:
   pull_request:
@@ -8,9 +8,9 @@ permissions:
   contents: write
 
 jobs:
-  build-docs:
+  test-docs:
     concurrency: ci-${{ github.ref }}
-    name: Build docs
+    name: Test docs
     runs-on: "ubuntu-latest"
     defaults:
       run:
@@ -31,5 +31,5 @@ jobs:
       - name: Install Hatch
         uses: pypa/hatch@install
 
-      - name: Build and deploy the documentation
+      - name: Build the documentation
         run: hatch run docs:build

docs/index.md

@@ -40,6 +40,8 @@ effect = StaticEffect(0.05)
 inflated_data = effect(trended_data)
 ```
 
+![Gaussian process posterior.](static/imgs/readme_fig.png)
+
 ## Model Validation
 
 Once a dataset has been synthesised, we may wish to validate our model using a placebo

docs/static/imgs/readme_fig.png

@@ -90,7 +90,7 @@ dependencies = [
 
 [tool.hatch.envs.docs.scripts]
 serve = "mkdocs serve --dev-addr localhost:8000"
-deploy = "mkdocs gh-deploy --force"
+deploy = ["python docs/scripts/gen_examples.py", "mkdocs build"]
 build = "mkdocs build"
 
 [tool.hatch.version]