From ac177a1fe697b8df8c5f27bf308549956ad74946 Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 19:12:53 +0100 Subject: [PATCH 1/5] Create .readthedocs.yaml necessitated by readthedocs updating the build process --- .readthedocs.yaml | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 .readthedocs.yaml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 000000000..c4b898afd --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# .readthedocs.yaml +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +# Set the version of Python and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.10" + +# 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 From 3eaadcd9cea889f5b46dff15c3518278c2404b11 Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 19:30:38 +0100 Subject: [PATCH 2/5] Update .readthedocs.yaml --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index c4b898afd..358cd17d1 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -13,7 +13,7 @@ build: # Build documentation in the docs/ directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html From 7d84637262bd142d48e231039aca22e4cf6bd86e Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 19:36:33 +0100 Subject: [PATCH 3/5] Update .readthedocs.yaml --- .readthedocs.yaml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 358cd17d1..957192b4c 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,6 +11,10 @@ build: tools: python: "3.10" +python: + install: + - requirements: docs/requirements_rtd + # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py From a3991be112aae01c4e14f15aec58ee443ddf7b9f Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 19:49:48 +0100 Subject: [PATCH 4/5] Update requirements_rtd --- docs/requirements_rtd | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements_rtd b/docs/requirements_rtd index 5e553be25..f718c92a7 100644 --- a/docs/requirements_rtd +++ b/docs/requirements_rtd @@ -2,3 +2,4 @@ sphinx>=3.0 ipykernel nbsphinx sphinx-rtd-theme==0.5.0 +recommonmark From d7e80ae207a3ac6f1c1a61bf04edbf66c5936cfb Mon Sep 17 00:00:00 2001 From: kccwing <60852830+kccwing@users.noreply.github.com> Date: Wed, 18 Oct 2023 20:01:58 +0100 Subject: [PATCH 5/5] Update requirements_rtd --- docs/requirements_rtd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements_rtd b/docs/requirements_rtd index f718c92a7..0710feb30 100644 --- a/docs/requirements_rtd +++ b/docs/requirements_rtd @@ -1,4 +1,4 @@ -sphinx>=3.0 +sphinx>=3.0,<7 ipykernel nbsphinx sphinx-rtd-theme==0.5.0