Skip to content

Commit

Permalink
add build environment spec to .readthedocs.yml config (#541)
Browse files Browse the repository at this point in the history
a build.os value is now required by readthedocs; see: https://blog.readthedocs.com/use-build-os-config/
  • Loading branch information
tomkinsc committed Jun 10, 2024
1 parent 19ddae7 commit 519a6a1
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@
# Required
version: 2

# build environment
# see: https://docs.readthedocs.io/en/stable/config-file/v2.html#build
build:
os: ubuntu-22.04
tools:
python: "3.10"

# Build documentation in the docs/ directory with Sphinx
sphinx:
builder: html
Expand All @@ -19,6 +26,5 @@ formats: all

# Optionally set the version of Python and requirements required to build your docs
python:
version: 3.8
install:
- requirements: docs/requirements.txt

0 comments on commit 519a6a1

Please sign in to comment.