Skip to content

Commit

Permalink
Update readthedocs build config (#215)
Browse files Browse the repository at this point in the history
* Update readthedocs build to use 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 Nov 10, 2023
1 parent ab55391 commit 9ef8e08
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 11 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
6 changes: 3 additions & 3 deletions envs/environment-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,9 @@ dependencies:
- tomli

# For documentation
- sphinx
- sphinx_rtd_theme=1.2
- sphinx-notfound-page
- sphinx=5.3.0
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=1.3.0

# For exploration
# - ipython
Expand Down
6 changes: 3 additions & 3 deletions envs/environment-fig-dev.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -69,9 +69,9 @@ dependencies:
- jupyterlab

# For documentation
- sphinx
- sphinx_rtd_theme=1.2
- sphinx-notfound-page
- sphinx=5.3.0
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=1.3.0

- pip:
- angles
Expand Down
6 changes: 3 additions & 3 deletions envs/environment-linkcheck.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,9 @@ dependencies:
- xarray

# For documentation links checking
- sphinx
- sphinx_rtd_theme=1.2
- sphinx-notfound-page
- sphinx=5.3.0
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=1.3.0

- pip:
- angles
Expand Down
11 changes: 10 additions & 1 deletion envs/environment-rtd.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,19 @@ dependencies:
- python=3.12
- retrying

# RTD packages
# Sphinx and extensions
- sphinx=5.3.0
- sphinx-notfound-page=1.0.0
- sphinx-rtd-theme=1.3.0

# readthedocs build system packages
- mock
- pillow
- pip:
- commonmark
- recommonmark
- readthedocs-sphinx-ext

# Install NEMO_Nowcast and SalishSeaNowcast packages in editable mode
- --editable git+https://github.com/43ravens/NEMO_Nowcast.git#egg=NEMO_Nowcast
- --editable ../

0 comments on commit 9ef8e08

Please sign in to comment.