Merge pull request #219 from goodmami/gh-214-.readthedocs.yaml

Add docs/.readthedocs.yaml

CHANGELOG.md

@@ -8,6 +8,10 @@
 * Remove reverse relations for `pertainym` and `also` ([#213])
 * Validate redundant relations considering `dc:type` ([#215])
 
+## Maintenance
+
+* Added `docs/.readthedocs.yaml` for building docs ([#214])
+
 
 ## [v0.10.0]
 
@@ -681,4 +685,5 @@ abandoned, but this is an entirely new codebase.
 [#207]: https://github.com/goodmami/wn/issues/207
 [#211]: https://github.com/goodmami/wn/issues/211
 [#213]: https://github.com/goodmami/wn/issues/213
+[#214]: https://github.com/goodmami/wn/issues/214
 [#215]: https://github.com/goodmami/wn/issues/215

docs/.readthedocs.yaml

@@ -0,0 +1,26 @@
+# .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.12"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+formats:
+  - pdf
+  - epub

docs/requirements.txt

@@ -1,5 +1,5 @@
-sphinx ~= 4.0
-furo == 2021.10.9
-sphinx-copybutton == 0.4.0
+sphinx ~= 8.1
+furo == 2024.8.6
+sphinx-copybutton == 0.5.2
 .