Skip to content

Commit

Permalink
Update readthedocs build config (#74)
Browse files Browse the repository at this point in the history
* Update readthedocs build config to mambaforge-22.9

* Pin versions of sphinx and optional extensions

As recommended for reproducible builds on readthedocs:
https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
and to ensure that our docs build works with readthedocs changes to default
project dependencies:
https://blog.readthedocs.com/defaulting-latest-build-tools/
  • Loading branch information
douglatornell authored Apr 9, 2024
1 parent 689b3dc commit dde0c45
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ version: 2
build:
os: ubuntu-22.04
tools:
python: "mambaforge-4.10"
python: "mambaforge-22.9"

conda:
environment: envs/environment-rtd.yaml
Expand Down
8 changes: 4 additions & 4 deletions envs/environment-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ dependencies:
- pytest-cov
- tomli

# For documentation
- sphinx
- sphinx_rtd_theme=1.2
- sphinx-notfound-page
# Sphinx and extensions
- sphinx=7.2.6
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=2.0.0

- pip:
- arrow
Expand Down
6 changes: 3 additions & 3 deletions envs/environment-rtd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,9 @@ dependencies:
- mock
- pillow
- pip
- sphinx
- sphinx_rtd_theme=1.2
- sphinx-notfound-page
- sphinx=7.2.6
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=2.0.0

- pip:
- pyramid
Expand Down
6 changes: 3 additions & 3 deletions envs/environment-test.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ dependencies:
- tomli

# For documentation links checking
- sphinx
- sphinx_rtd_theme=1.2
- sphinx-notfound-page
- sphinx=7.2.6
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=2.0.0

- pip:
- arrow
Expand Down
2 changes: 1 addition & 1 deletion envs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ six==1.16.0
snowballstemmer==2.2.0
Sphinx==7.2.6
sphinx-notfound-page==1.0.0
sphinx-rtd-theme==1.2.2
sphinx-rtd-theme==2.0.0
sphinxcontrib-applehelp==1.0.7
sphinxcontrib-devhelp==1.0.5
sphinxcontrib-htmlhelp==2.0.4
Expand Down

0 comments on commit dde0c45

Please sign in to comment.