From 9e806e3677c0469cab3398a0444dcea3d9d68895 Mon Sep 17 00:00:00 2001 From: RichardObi Date: Mon, 3 Jun 2024 14:29:38 +0200 Subject: [PATCH 1/4] Update of readthedocs.yaml file necessary due to version 2 required (see https://blog.readthedocs.com/migrate-configuration-v2/), (addresses: https://github.com/RichardObi/medigan/issues/67) --- .readthedocs.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f1e447c..7fc7329 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,6 +1,7 @@ # File: .readthedocs.yaml -version: 1 +# Required +version: 2 sphinx: configuration: docs/conf.py From 66d37d3886c5afe0b9d4c2d9fdb2f6f895c170c4 Mon Sep 17 00:00:00 2001 From: RichardObi Date: Mon, 3 Jun 2024 14:40:18 +0200 Subject: [PATCH 2/4] Further update of .readthedocus.yaml file to satisfy v2 requirements. --- .readthedocs.yaml | 17 ++++++++++++++--- 1 file changed, 14 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 7fc7329..316e463 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,12 +1,23 @@ -# File: .readthedocs.yaml +# File: .readthedocs.yaml (see example: https://docs.readthedocs.io/en/stable/config-file/v2.html) -# Required +# Required (see https://blog.readthedocs.com/migrate-configuration-v2/) version: 2 +# Set the OS, Python version and other tools you might need +build: + os: ubuntu-22.04 + tools: + python: "3.8" + +# Build documentation in the "docs/" directory with Sphinx sphinx: configuration: docs/conf.py +# Optional but recommended, declare the Python requirements required +# to build your documentation +# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: version: 3.8 install: - - requirements: docs/requirements.txt \ No newline at end of file + - requirements: docs/requirements.txt + From a940af353badddf5374c55cb7fe4f58b952a5521 Mon Sep 17 00:00:00 2001 From: RichardObi Date: Mon, 3 Jun 2024 14:42:52 +0200 Subject: [PATCH 3/4] Further update of .readthedocus.yaml file to satisfy v2 requirements. Removing explicit python version. --- .readthedocs.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 316e463..695f9da 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -17,7 +17,6 @@ sphinx: # to build your documentation # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - version: 3.8 install: - requirements: docs/requirements.txt From 463aab130f4bbb96dd656e13a28bb89c87fdf6c9 Mon Sep 17 00:00:00 2001 From: RichardObi Date: Mon, 3 Jun 2024 14:49:52 +0200 Subject: [PATCH 4/4] Further update of .readthedocus.yaml file to satisfy v2 requirements. conf.py path. --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 695f9da..bc54e4a 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -11,7 +11,7 @@ build: # Build documentation in the "docs/" directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py # Optional but recommended, declare the Python requirements required # to build your documentation