From f675595d97672e61f15767680acfb1138bdbe1e3 Mon Sep 17 00:00:00 2001
From: Dane Finlay <dane@danefinlay.net>
Date: Fri, 29 Mar 2024 12:26:32 +1100
Subject: [PATCH] Add .readthedocs.yaml config file & doc build requirements
 file

---
 .readthedocs.yaml              | 36 ++++++++++++++++++++++++++++++++++
 documentation/requirements.txt |  2 ++
 2 files changed, 38 insertions(+)
 create mode 100644 .readthedocs.yaml
 create mode 100644 documentation/requirements.txt

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..128edda
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,36 @@
+# .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.10"
+    # 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: documentation/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:
+  install:
+    - requirements: documentation/requirements.txt
diff --git a/documentation/requirements.txt b/documentation/requirements.txt
new file mode 100644
index 0000000..da819b1
--- /dev/null
+++ b/documentation/requirements.txt
@@ -0,0 +1,2 @@
+Sphinx
+mock