From f4da72b0acbedaf23a2d3b427843c626838217bd Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Fri, 22 Nov 2024 08:50:59 +0100 Subject: [PATCH 1/4] Configure for readthedocs --- .readthedocs.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..080b0a6 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# Read the Docs configuration file for Sphinx projects +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.12" + +# Build documentation in the "docs/" directory with Sphinx +sphinx: + configuration: docs/conf.py From 7faba45e6cd80d9be623b624028f3693ab385dba Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Fri, 22 Nov 2024 13:42:49 +0100 Subject: [PATCH 2/4] Apply suggestions from code review Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- .readthedocs.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 080b0a6..4ec8b60 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,9 +6,9 @@ version: 2 # Set the OS, Python version and other tools you might need build: - os: ubuntu-22.04 + os: ubuntu-lts-latest tools: - python: "3.12" + python: "3" # Build documentation in the "docs/" directory with Sphinx sphinx: From e9fa0e32a06ba9225787e6b2f179cb9cb813343a Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Fri, 22 Nov 2024 13:46:22 +0100 Subject: [PATCH 3/4] Create requirements.txt --- docs/requirements.txt | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 docs/requirements.txt diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..ab3f3dd --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +Sphinx +sphinx_rtd_theme From d4eae0672a745791aad5ff10bd69e0064622e6db Mon Sep 17 00:00:00 2001 From: Michael Howitz Date: Fri, 22 Nov 2024 13:47:08 +0100 Subject: [PATCH 4/4] Install theme. --- .readthedocs.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 4ec8b60..31511c6 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,3 +13,11 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py + +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html +python: + install: + - requirements: docs/requirements.txt + - method: pip + path: .