Fix 'readthedocs' build failure (#861)

Add a new .readthedocs.yaml file, which is now required by ReadTheDocs. Remove references to "sphinxconfig.bibtex", which is not currently used by our documentation. Fixes #860.
ufs-community · Oct 18, 2023 · b31385f · b31385f
1 parent 773fe3c
commit b31385f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,15 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.9"
+
+sphinx:
+   configuration: docs/source/conf.py
diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -50,11 +50,10 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'sphinx.ext.githubpages',
-    'sphinx.ext.napoleon',
-    'sphinxcontrib.bibtex'
+    'sphinx.ext.napoleon'
 ]
 
-bibtex_bibfiles = ['references.bib']
+#bibtex_bibfiles = ['references.bib']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']