Merge pull request #6 from yantosca/feature/add-readthedocs-yaml-file

Add .readthedocs.yaml and docs/requirements.txt to futureproof against updates at the RTD site

.readthedocs.yaml

@@ -0,0 +1,33 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+#
+# NOTE: This is now needed in order to prevent builds from failing due
+# to Python package issues at the ReadTheDocs site. For more info, see:
+# https://github.com/readthedocs/readthedocs.org/issues/10290
+#   -- Bob Yantosca (10 May 2023)
+
+# Required
+version: 2
+
+## Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+    nodejs: "14"
+    rust:   "1.55"
+    golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats: all
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

docs/requirements.txt

@@ -0,0 +1,16 @@
+# Requirements for building the CHEEREIO documentation
+#
+# NOTE: Use specific versions for Python packages instead of upper
+# bounds.  Using an upper bound will not necessarily install the
+# intended version if there already is a version that meets the
+# criteria present in the Python environment.
+#  -- Bob Yantosca and Lizzie Lundgren (27 Sep 2022)
+#
+# The following package versions have been proven to work together:
+#
+sphinx==3.5.4
+sphinx_rtd_theme==0.5.2
+sphinxcontrib-bibtex==2.2.0
+recommonmark
+docutils==0.16
+jinja2==3.0.3