Set up a ReadTheDocs configuration file (#59)

* Set up a ReadTheDocs configuration file * Need import os
ubarsc · Jun 19, 2023 · f8cae3c · f8cae3c
1 parent b2c110c
commit f8cae3c
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 1 deletion.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,20 @@
+# .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"
+
+# Build documentation in the doc/ directory with Sphinx
+sphinx:
+  configuration: doc/source/conf.py
+
+python:
+  install:
+    - requirements: doc/requirements.txt
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -0,0 +1 @@
+sphinx==7
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -14,11 +14,15 @@
 # serve to show the default.
 
 import sys
-import rios  # for version info
+import os
 
 # Set up 'mock' modules, needed to build docs if numpy, gdal etc., aren't installed
 import mock
 
+sys.path.insert(0, os.path.abspath('../..'))
+# for version info
+import rios          # noqa: E402
+
 MOCK_MODULES = ['numpy', 'osgeo', 'gdal', 'osgeo.gdal', 'cloud',
                 'cloud.serialization']
 for mod_name in MOCK_MODULES: