Add an RTD config file to resolve RTD build failures (#977)

jpadilla · Aug 25, 2024 · 223e50d · 223e50d
1 parent d7710f7
commit 223e50d
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,19 @@
+# https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+version: 2
+
+build:
+  os: "ubuntu-lts-latest"
+  tools:
+    python: "3.11"
+
+python:
+  install:
+    - method: "pip"
+      path: "."
+      extra_requirements:
+        - "docs"
+
+sphinx:
+  configuration: "docs/conf.py"
+  fail_on_warning: true
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,5 @@
 include .pre-commit-config.yaml
+include .readthedocs.yaml
 include CODE_OF_CONDUCT.md
 include AUTHORS.rst
 include CHANGELOG.rst

diff --git a/tox.ini b/tox.ini
@@ -41,6 +41,7 @@ commands = {envpython} -b -m coverage run -m pytest {posargs}
 
 
 [testenv:docs]
+# The tox config must match the ReadTheDocs config.
 basepython = python3.11
 extras = docs
 commands =