From c7d1f6ebf43820822c2b62388ffbf48dba1b31e7 Mon Sep 17 00:00:00 2001
From: Jakub Stasiak <jakub@stasiak.at>
Date: Wed, 13 Dec 2023 22:48:09 +0100
Subject: [PATCH] Provide ReadTheDocs configuration (#275) (#240)

RTD has been requiring a configuration file for a while, this change
should resolve the currently ongoing documentation build failures.
---
 .readthedocs.yaml | 22 ++++++++++++++++++++++
 MANIFEST.in       |  1 +
 2 files changed, 23 insertions(+)
 create mode 100644 .readthedocs.yaml

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 0000000..31ea7c5
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,22 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+  # TODO: Enable this when we get rid of the existing warnings
+  # fail_on_warning: true
+
+python:
+  install:
+    - method: pip
+      path: .
+# TODO: pin the development dependency versions
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+#     - requirements: docs/requirements.txt
diff --git a/MANIFEST.in b/MANIFEST.in
index 78c6184..7277df6 100644
--- a/MANIFEST.in
+++ b/MANIFEST.in
@@ -11,3 +11,4 @@ recursive-include docs *.html
 recursive-include docs *.py
 recursive-include docs *.rst
 recursive-include docs Makefile
+exclude .readthedocs.yaml