Skip to content

Commit

Permalink
Update .readthedocs.yml configuration
Browse files Browse the repository at this point in the history
Newest Read the Docs configuration file requires explicit specification
of the environment (using `build:`).  This patch includes this section.

Upgrading to newer Python environments has also forced us to specify an
older Jinja2 that works with our legacy Sphinx module.
  • Loading branch information
marshallward committed Oct 26, 2023
1 parent f6b6b0b commit e41929e
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 2 deletions.
11 changes: 9 additions & 2 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
# Read the Docs configuration file for Sphinx projects
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

build:
os: ubuntu-22.04
tools:
python: "3.11"

# Extra formats
# PDF generation is failing for now; disabled on 2020-12-02
#formats:
Expand All @@ -10,7 +19,5 @@ sphinx:
configuration: docs/conf.py

python:
# make sure we're using Python 3
version: 3
install:
- requirements: docs/requirements.txt
2 changes: 2 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ sphinxcontrib-bibtex
numpy
six
future
# Old Sphinx requires an old Jinja2
jinja2<3.1

0 comments on commit e41929e

Please sign in to comment.