Switch to .readthedocs.yaml file for rtd configuration

griffithlab · Oct 11, 2021 · f9bf3c7 · f9bf3c7
1 parent 098f21d
commit f9bf3c7
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 7 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,25 @@
+# .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-20.04
+  tools:
+    python: "3.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.before_install.txt
+   - requirements: requirements.txt
+   - requirements: docs/requirements.txt
+   - method: pip
+     path: .
diff --git a/docs/requirements.before_install.txt b/docs/requirements.before_install.txt
@@ -0,0 +1 @@
+setuptools==57.4.0
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,3 @@
 sphinx==3.0.0
-sphinxjp.themes.basicstrap
-sphinxcontrib-programoutput
-pvactools
---install-option="--no-deps"
+sphinxjp.themes.basicstrap==0.5.0
+sphinxcontrib-programoutput==0.17
diff --git a/readthedocs.yml b/readthedocs.yml