From 8f09ad263e0cc413d6172aa002af71be0976a35f Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Mon, 16 Jan 2023 10:56:23 +0100 Subject: [PATCH 01/10] use python 3.10 in the docs environment --- ci/requirements/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index 5b39a4d7d19..c2b816ae3e0 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -4,7 +4,7 @@ channels: - conda-forge - nodefaults dependencies: - - python=3.9 + - python=3.10 - bottleneck - cartopy - cfgrib>=0.9 From 0a894fed014a9be19ba0955f5ad94ac956060fc2 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Mon, 16 Jan 2023 10:57:02 +0100 Subject: [PATCH 02/10] require a more recent `sphinx` version --- ci/requirements/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index c2b816ae3e0..8e1077da59e 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -34,7 +34,7 @@ dependencies: - sphinx-book-theme >= 0.0.38 - sphinx-copybutton - sphinx-design - - sphinx!=4.4.0 + - sphinx>=5.0 - zarr>=2.4 - pip: - sphinxext-rediraffe From 3a46fc7f93b22a0be61e4131685f1aff02805d14 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Mon, 16 Jan 2023 10:57:32 +0100 Subject: [PATCH 03/10] [skip-ci] From c5413b7e87eedf0158a8dce1832bd666b4e5f64c Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Mon, 16 Jan 2023 11:21:08 +0100 Subject: [PATCH 04/10] remove the unused pydata-sphinx-theme [skip-ci] --- ci/requirements/doc.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index 8e1077da59e..0ba48cb70c8 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -23,7 +23,6 @@ dependencies: - pandas>=1.3 - pooch - pip - - pydata-sphinx-theme>=0.4.3 - pyproj - rasterio>=1.1 - scipy!=1.10.0 From 8742a39a945a73e6e460fbed41796ba880c4d461 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Tue, 14 Feb 2023 18:16:28 +0100 Subject: [PATCH 05/10] pin `sphinx-book-theme` to a more recent version [skip-ci] --- ci/requirements/doc.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ci/requirements/doc.yml b/ci/requirements/doc.yml index c88d1417c6d..cc6f13e7086 100644 --- a/ci/requirements/doc.yml +++ b/ci/requirements/doc.yml @@ -30,7 +30,7 @@ dependencies: - setuptools - sparse - sphinx-autosummary-accessors - - sphinx-book-theme >= 0.0.38 + - sphinx-book-theme >= 0.3.0 - sphinx-copybutton - sphinx-design - sphinx>=5.0 From e411bd7e0a2ecde4a1015d9b7955f93c6ef9d0bf Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Thu, 2 Mar 2023 22:25:59 +0100 Subject: [PATCH 06/10] try working around the theme bug [skip-ci] --- doc/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/doc/conf.py b/doc/conf.py index c916fde5760..03a85f8f498 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -250,6 +250,7 @@ a nonprofit dedicated to supporting the open-source scientific computing community.
Theme by the Executable Book Project

""", twitter_url="https://twitter.com/xarray_devs", + icon_links=[], # workaround for pydata/pydata-sphinx-theme#1220 ) From ca9a29c9bd5a427596568de3d8682187e4aa0f5e Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Thu, 2 Mar 2023 22:53:08 +0100 Subject: [PATCH 07/10] use string interpolation markers for the extlink text --- doc/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 03a85f8f498..59c03ceab21 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -97,8 +97,8 @@ extlinks = { - "issue": ("https://github.com/pydata/xarray/issues/%s", "GH"), - "pull": ("https://github.com/pydata/xarray/pull/%s", "PR"), + "issue": ("https://github.com/pydata/xarray/issues/%s", "GH%s"), + "pull": ("https://github.com/pydata/xarray/pull/%s", "PR%s"), } # sphinx-copybutton configurations From b70a48251f1ac901b8b460599a57a7860aa1b5a4 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Thu, 2 Mar 2023 22:58:33 +0100 Subject: [PATCH 08/10] try specifying the project of a intersphinx link --- doc/user-guide/interpolation.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/user-guide/interpolation.rst b/doc/user-guide/interpolation.rst index 2dc47e9f591..7b40962e826 100644 --- a/doc/user-guide/interpolation.rst +++ b/doc/user-guide/interpolation.rst @@ -50,7 +50,7 @@ array-like, which gives the interpolated result as an array. # interpolation da.interp(time=[2.5, 3.5]) -To interpolate data with a :py:doc:`numpy.datetime64 ` coordinate you can pass a string. +To interpolate data with a :py:doc:`numpy.datetime64 ` coordinate you can pass a string. .. ipython:: python From d05d1d9945348ff862ae111048400c326f150e23 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Thu, 2 Mar 2023 23:21:18 +0100 Subject: [PATCH 09/10] remove the empty `extra_navbar` and `navbar_footer_text` theme options --- doc/conf.py | 2 -- 1 file changed, 2 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index 59c03ceab21..0b6c6766c3b 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -244,8 +244,6 @@ use_repository_button=True, use_issues_button=True, home_page_in_toc=False, - extra_navbar="", - navbar_footer_text="", extra_footer="""

Xarray is a fiscally sponsored project of NumFOCUS, a nonprofit dedicated to supporting the open-source scientific computing community.
Theme by the Executable Book Project

""", From 106843ca3afea25c4c9a08c8f902c8354fb82836 Mon Sep 17 00:00:00 2001 From: Justus Magin Date: Thu, 2 Mar 2023 23:21:41 +0100 Subject: [PATCH 10/10] [skip-ci]