From d1b4922c5f3e20c01a91a89ee2b80f099907bc55 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Duque=20Mesa?= <675763+sduquemesa@users.noreply.github.com> Date: Tue, 9 May 2023 16:16:11 -0400 Subject: [PATCH] Refactor sphinx config and bump docs python version (#364) * fix [.readthedocs.yml] - increase python version Fixes urllib3 v2.0 not supporting versions <1.1.1 of openSSL. See https://github.com/readthedocs/readthedocs.org/issues/10290. * fix [.readthedocs.yml] - set container image and python version * unpin doc requirements --- .readthedocs.yml | 15 +++++++-------- docs/requirements.txt | 8 ++++---- 2 files changed, 11 insertions(+), 12 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 532073a76..c825b071c 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,19 +9,18 @@ version: 2 sphinx: configuration: docs/conf.py -# Build documentation with MkDocs -#mkdocs: -# configuration: mkdocs.yml - # Optionally build your docs in additional formats such as PDF and ePub formats: - htmlzip -# Optionally set the version of Python and requirements required to build your docs +# Set the version of Python and container image +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# Set the requirements required to build your docs python: - version: 3.8 install: - requirements: docs/requirements.txt -build: - image: latest diff --git a/docs/requirements.txt b/docs/requirements.txt index 51d66b7e3..066d3151a 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,13 +1,13 @@ -docutils==0.16 +docutils sphinxcontrib-bibtex -sphinx==3.5.3 +sphinx ipykernel -nbsphinx==0.7 +nbsphinx numba>=0.49.1 numpy>=1.9 sympy>=1.5.1 scipy>=1.8.0 -Jinja2==2.11.3 +Jinja2 version_information sphinx-copybutton dask[delayed]