Add RTD config

Author: ConorMacBride

.github/workflows/docs.yml

@@ -0,0 +1,27 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "mambaforge-4.10"
+
+conda:
+  environment: docs/rtd_environment.yaml
+
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
+# Install regular dependencies.
+# Then, install special pinning for RTD.
+python:
+  system_packages: false
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+# Don't build any extra formats
+formats: []

.readthedocs.yaml

@@ -0,0 +1,8 @@
+name: rtd311
+channels:
+  - conda-forge
+  - defaults
+dependencies:
+  - python=3.11
+  - pip
+  - graphviz

docs/rtd_environment.yaml

@@ -36,7 +36,7 @@ def run_pytest(test_name):
         lambda x: x.name[:-1] in test_name,
         pathlib.Path(tmp_dir).glob("*0")
     )) / "results"
-    os.replace(src, dest)
+    shutil.copytree(src, dest)
 
     return dest
 

docs/sample_summaries.py

@@ -43,6 +43,7 @@ docs =
     sphinx
     mpl_sphinx_theme>=3.6.0.dev0
     sphinx_design
+    matplotlib==3.6
 
 [tool:pytest]
 testpaths = tests