From e41929e073a6397d099a71fe2009fa0361f017e9 Mon Sep 17 00:00:00 2001 From: Marshall Ward Date: Thu, 26 Oct 2023 12:03:12 -0400 Subject: [PATCH] Update .readthedocs.yml configuration 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. --- .readthedocs.yml | 11 +++++++++-- docs/requirements.txt | 2 ++ 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index f7ad4421b4..4fe8d6300d 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -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: @@ -10,7 +19,5 @@ sphinx: configuration: docs/conf.py python: - # make sure we're using Python 3 - version: 3 install: - requirements: docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt index 52fcf95bc0..ff627c61c7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -8,3 +8,5 @@ sphinxcontrib-bibtex numpy six future +# Old Sphinx requires an old Jinja2 +jinja2<3.1