From 6e37a64c50c84374c944d2a8b796ab87280d5977 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Mon, 25 Sep 2023 13:23:40 +0200 Subject: [PATCH 1/7] Add readthedocs configuration file --- .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 00000000..dff7fe59 --- /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.11" + +# 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: requirements-docs.txt \ No newline at end of file From bcbb30c9dea17fbeb8faad9336bc11f1b448bd89 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Mon, 25 Sep 2023 13:31:12 +0200 Subject: [PATCH 2/7] Fix name of requirements file --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index dff7fe59..d1786722 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -19,4 +19,4 @@ sphinx: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: requirements-docs.txt \ No newline at end of file + - requirements: requirements-doc.txt From 6108ad5d5ca018516facf757930105bff0047375 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Mon, 25 Sep 2023 13:36:45 +0200 Subject: [PATCH 3/7] Update path to conf.py --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d1786722..b0130f20 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: doc/conf.py # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html From 4a2e2020316478a50b0da6e1c21996e4ab8e5cc1 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Mon, 25 Sep 2023 13:53:06 +0200 Subject: [PATCH 4/7] Change python version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index b0130f20..629eb1fa 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-22.04 tools: - python: "3.11" + python: "3.8" # Build documentation in the docs/ directory with Sphinx sphinx: From 7be5726252b8d4e095965b6e24e9a8f73050b182 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Mon, 25 Sep 2023 14:08:44 +0200 Subject: [PATCH 5/7] Update package versions, trying to fix undefined variable 'key' --- requirements-doc.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/requirements-doc.txt b/requirements-doc.txt index 383cf836..99de59de 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -1,7 +1,7 @@ # Packages for read the docs # Using single requirments for docs, see: # https://github.com/rtfd/readthedocs.org/issues/2070 -sphinx_rtd_theme +sphinx_rtd_theme == 1.3.0 pypsa == 0.20.1 numpydoc sqlalchemy @@ -9,4 +9,5 @@ geoalchemy2 matplotlib nbsphinx saio -pyomo != 6.4.3 \ No newline at end of file +pyomo != 6.4.3 +sphinx From bcc7c070aa6e947ae965ca2514b96cec1bac4cd7 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Tue, 26 Sep 2023 08:44:07 +0200 Subject: [PATCH 6/7] Revert "Update package versions, trying to fix undefined variable 'key'" This reverts commit 7be5726252b8d4e095965b6e24e9a8f73050b182. --- requirements-doc.txt | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/requirements-doc.txt b/requirements-doc.txt index 99de59de..383cf836 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -1,7 +1,7 @@ # Packages for read the docs # Using single requirments for docs, see: # https://github.com/rtfd/readthedocs.org/issues/2070 -sphinx_rtd_theme == 1.3.0 +sphinx_rtd_theme pypsa == 0.20.1 numpydoc sqlalchemy @@ -9,5 +9,4 @@ geoalchemy2 matplotlib nbsphinx saio -pyomo != 6.4.3 -sphinx +pyomo != 6.4.3 \ No newline at end of file From 8bed6ca2144a78fefb1bb71f9e86fa28444bce79 Mon Sep 17 00:00:00 2001 From: ClaraBuettner Date: Tue, 26 Sep 2023 08:46:05 +0200 Subject: [PATCH 7/7] Set lower version for sphinx_rtd_theme --- requirements-doc.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements-doc.txt b/requirements-doc.txt index 383cf836..864c6327 100644 --- a/requirements-doc.txt +++ b/requirements-doc.txt @@ -1,7 +1,7 @@ # Packages for read the docs # Using single requirments for docs, see: # https://github.com/rtfd/readthedocs.org/issues/2070 -sphinx_rtd_theme +sphinx_rtd_theme > 1.2.2 pypsa == 0.20.1 numpydoc sqlalchemy