chore: add readthedocs config (#1674)

* add top level config * Add python requirements * Update pyyaml to avoid wheel error * Update exhale to support docs --------- Co-authored-by: Michael Hank <[email protected]>
UCATLAS · Feb 7, 2024 · 7e8797c · 7e8797c
1 parent 530f27d
commit 7e8797c
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 2 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,29 @@
+# .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.11"
+  apt_packages:
+    - curl
+    - jq
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF and ePub
+formats: all
+
+# 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/requirements.txt
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -6,7 +6,7 @@ bs4==0.0.1
 certifi==2023.7.22
 chardet==3.0.4
 docutils==0.15.2
-exhale==0.2.3
+exhale==0.2.4
 idna==2.8
 imagesize==1.1.0
 Jinja2==3.1.3
@@ -16,7 +16,7 @@ packaging==19.2
 Pygments==2.15.0
 pyparsing==2.4.5
 pytz==2019.3
-PyYAML==5.4
+PyYAML==6.0
 requests==2.31.0
 six==1.13.0
 snowballstemmer==2.0.0