ci: Fix readthedocs build

Mirrors the approach used by httpstan. On readthedocs build machines we first install the packages in `docs-requirements.txt` and then install the pystan package (bringing in all the normal requirements). Then we build the docs.
stan-dev · Jul 7, 2022 · 19052f8 · 19052f8
1 parent 567bed8
commit 19052f8
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -10,7 +10,6 @@ sphinx:
 
 python:
   install:
+    - requirements: docs-requirements.txt
     - method: pip
       path: .
-      extra_requirements:
-        - docs
diff --git a/docs-requirements.txt b/docs-requirements.txt
@@ -0,0 +1,5 @@
+# docs requirements
+# these requirements are used by the documentation builder
+
+sphinx~=4.2 # BSD
+sphinx-rtd-theme~=1.0.0
diff --git a/pyproject.toml b/pyproject.toml
@@ -41,7 +41,8 @@ mypy = "0.961"
 types-setuptools = "^57.4"
 flake8 = "^4.0"
 # documentation
-sphinx = "^5.0"
+# NOTE: when changing these, update docs-requirements.txt
+sphinx = "^4.2"
 sphinx-rtd-theme = "^1.0"
 
 [tool.black]