Merge pull request #35 from boutproject/rtd

Update RTD config

Author: dschwoerer

.readthedocs.yml

@@ -1,5 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
 build:
-  image: latest
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
 
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
 python:
-  version: 3.6
+  install:
+    - requirements: docs/requirements.txt

docs/requirements.txt

@@ -3,4 +3,6 @@ ipykernel
 nbsphinx
 matplotlib>=2.2
 sphinx_rtd_theme
-numpy
+numpy
+build
+setuptools_scm[toml]>=7

docs/source/conf.py

@@ -26,6 +26,13 @@
 
 # Find the version number
 _version_py = "../../animatplot/_version.py"
+if not os.path.exists(_version_py):
+    import subprocess
+
+    subprocess.run(
+        "python -m build ../.. --no-isolation --sdist", shell=True, check=False
+    )
+
 version_ns = {}
 with open(_version_py) as f:
     exec(f.read(), {}, version_ns)