Add readthedocs config

sigmavirus24 · sigmavirus24 · commit af9eed201d89 · 2025-06-07T12:53:56.000-05:00
diff --git a/docs/.readthedocs.yaml b/docs/.readthedocs.yaml
@@ -0,0 +1,43 @@
+# 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:
+  os: ubuntu-lts-latest
+
+  tools:
+    python: "latest"
+
+    # 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:
+  install:
+  - requirements: docs/source/requirements.txt
