Add missing .readthedocs.yaml

tomschr · tomschr · commit ec9348aefd8e · 2023-10-09T13:48:58.000+02:00
According to [1], the .readthedocs.yaml configuration file is now required. The last builds have failed. [1] https://blog.readthedocs.com/migrate-configuration-v2/
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,5 @@
 # requirements file for documentation
 # sphinx
+# required in .readthedocs.yaml
 sphinx-argparse
 sphinx-autodoc-typehints
