From 0a889eeefe4452938d8826172d8cd1ec3ff02908 Mon Sep 17 00:00:00 2001 From: William Moore Date: Thu, 24 Aug 2023 21:57:14 +0100 Subject: [PATCH 01/10] Add sphinx_rtd_theme to docs dependencies --- docs/source/conf.py | 1 + docs/source/requirements.txt | 2 ++ 2 files changed, 3 insertions(+) create mode 100644 docs/source/requirements.txt diff --git a/docs/source/conf.py b/docs/source/conf.py index 854cc342..559f2df2 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -9,6 +9,7 @@ "sphinx.ext.doctest", "sphinx.ext.autodoc", "sphinx.ext.intersphinx", + "sphinx_rtd_theme", ] # use index.rst instead of contents.rst diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt new file mode 100644 index 00000000..691e5218 --- /dev/null +++ b/docs/source/requirements.txt @@ -0,0 +1,2 @@ +sphinx==5.3.0 +sphinx_rtd_theme==1.1.1 From da4151d95cb2b9efc0241cf4ed8b6082a220a611 Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 09:17:17 +0100 Subject: [PATCH 02/10] Specify requirements.txt in .readthedocs.yml --- .readthedocs.yml | 1 + docs/{source => }/requirements.txt | 0 2 files changed, 1 insertion(+) rename docs/{source => }/requirements.txt (100%) diff --git a/.readthedocs.yml b/.readthedocs.yml index 13ae5bed..4e1ce7ea 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -31,3 +31,4 @@ python: install: - method: pip path: . + - requirements: docs/requirements.txt diff --git a/docs/source/requirements.txt b/docs/requirements.txt similarity index 100% rename from docs/source/requirements.txt rename to docs/requirements.txt From fd682c84b24fab6f1245c594e73685775aca3164 Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 09:51:32 +0100 Subject: [PATCH 03/10] Remove method: pip from rtd python.install To match all examples at https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html --- .readthedocs.yml | 2 -- 1 file changed, 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 4e1ce7ea..a461605f 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -29,6 +29,4 @@ sphinx: # Optionally declare the Python requirements required to build your docs python: install: - - method: pip - path: . - requirements: docs/requirements.txt From 492b29c78321be3a617364e388e07da92e0ea44c Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 10:17:51 +0100 Subject: [PATCH 04/10] Updating to match rtd tutorial template at https://github.com/readthedocs/tutorial-template/blob/main/docs/requirements.txt --- .readthedocs.yml | 2 +- docs/requirements.txt | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index a461605f..fc2e4840 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -9,7 +9,7 @@ version: 2 build: os: ubuntu-20.04 tools: - python: "3.9" + python: "3.10" # You can also specify other tool versions: # nodejs: "16" # rust: "1.55" diff --git a/docs/requirements.txt b/docs/requirements.txt index 691e5218..53fc1f32 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,2 @@ -sphinx==5.3.0 -sphinx_rtd_theme==1.1.1 +sphinx==7.1.2 +sphinx-rtd-theme==1.3.0rc1 From 14ee7e4ede40c33a5ba6f2e9f9c69ababa2805ce Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 10:37:59 +0100 Subject: [PATCH 05/10] Add html_theme to conf.py --- docs/source/conf.py | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/source/conf.py b/docs/source/conf.py index 559f2df2..3825cd12 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -29,3 +29,6 @@ "numpy": ("https://numpy.org/doc/stable/", None), "zarr": ("https://zarr.readthedocs.io/en/stable/", None), } + +# https://github.com/readthedocs/sphinx_rtd_theme +html_theme = "sphinx_rtd_theme" From 24a09e5c9d8facc1b45cefad257b33bb7bde910c Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 10:44:42 +0100 Subject: [PATCH 06/10] Add deps to requirements.txt based on rtd build errors --- docs/requirements.txt | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 53fc1f32..3f855685 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,6 @@ sphinx==7.1.2 sphinx-rtd-theme==1.3.0rc1 +zarr +dask +numpy +scipy From f1dbe72b65efd5a76d9db33383fd91607f0a750a Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 10:54:03 +0100 Subject: [PATCH 07/10] Add deps to requirements.txt based on rtd build errors --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 3f855685..d8714270 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,3 +4,4 @@ zarr dask numpy scipy +skimage From 9152f31dac18fc805cde5eda1021d873cbad48c5 Mon Sep 17 00:00:00 2001 From: William Moore Date: Fri, 25 Aug 2023 11:18:17 +0100 Subject: [PATCH 08/10] Add deps to requirements.txt based on rtd build errors --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index d8714270..c2a20d9f 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -4,4 +4,4 @@ zarr dask numpy scipy -skimage +scikit-image From 36f2b4d3debd018e9af277ea75ef7dd35e18026e Mon Sep 17 00:00:00 2001 From: William Moore Date: Tue, 12 Sep 2023 11:17:40 +0100 Subject: [PATCH 09/10] Use sphinx-rtd-theme==1.3.0 --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index c2a20d9f..19884415 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ sphinx==7.1.2 -sphinx-rtd-theme==1.3.0rc1 +sphinx-rtd-theme==1.3.0 zarr dask numpy From 17ee62ac553879d269e1486f03710c2505c102e1 Mon Sep 17 00:00:00 2001 From: William Moore Date: Tue, 12 Sep 2023 11:30:46 +0100 Subject: [PATCH 10/10] Temp cap fsspec to avoid https://github.com/fsspec/filesystem_spec/pull/1358 --- docs/requirements.txt | 1 + requirements/requirements-dev.txt | 1 + 2 files changed, 2 insertions(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 19884415..76aa0da8 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,6 @@ sphinx==7.1.2 sphinx-rtd-theme==1.3.0 +fsspec==2023.6.0 zarr dask numpy diff --git a/requirements/requirements-dev.txt b/requirements/requirements-dev.txt index d5a00601..2931335e 100644 --- a/requirements/requirements-dev.txt +++ b/requirements/requirements-dev.txt @@ -1,3 +1,4 @@ +fsspec==2023.6.0 black cython >= 0.29.16 numpy >= 1.16.0