Skip to content

Commit 19052f8

Browse files
committed
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.
1 parent 567bed8 commit 19052f8

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

.readthedocs.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ sphinx:
1010

1111
python:
1212
install:
13+
- requirements: docs-requirements.txt
1314
- method: pip
1415
path: .
15-
extra_requirements:
16-
- docs

docs-requirements.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# docs requirements
2+
# these requirements are used by the documentation builder
3+
4+
sphinx~=4.2 # BSD
5+
sphinx-rtd-theme~=1.0.0

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@ mypy = "0.961"
4141
types-setuptools = "^57.4"
4242
flake8 = "^4.0"
4343
# documentation
44-
sphinx = "^5.0"
44+
# NOTE: when changing these, update docs-requirements.txt
45+
sphinx = "^4.2"
4546
sphinx-rtd-theme = "^1.0"
4647

4748
[tool.black]

0 commit comments

Comments
 (0)