Merge pull request #195 from ConorMacBride/rtd

Add RTD config

Author: ConorMacBride

.github/workflows/docs.yml

@@ -0,0 +1,17 @@
+version: 2
+
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+python:
+  system_packages: false
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+
+# Don't build any extra formats
+formats: []

.readthedocs.yaml

@@ -60,7 +60,7 @@
     "navbar_links": "absolute",
     "show_prev_next": False,
     "logo": {"link": "https://matplotlib.org/stable/",
-             "image_light": "images/logo2.svg",
+             "image_light": "images/logo_light.svg",
              "image_dark": "images/logo_dark.svg"},
     "collapse_navigation": False,
 }

docs/conf.py

@@ -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