From f190415d154adc4ab740efbf65470b4cf6b27683 Mon Sep 17 00:00:00 2001 From: Ruth Comer <10599679+rcomer@users.noreply.github.com> Date: Wed, 4 Jan 2023 18:02:06 +0000 Subject: [PATCH 1/2] link percentile as lazy option (#5128) --- docs/src/whatsnew/latest.rst | 4 ++++ lib/iris/analysis/__init__.py | 3 ++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index d1aae76675..2029e24855 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -69,6 +69,10 @@ This document explains the changes made to Iris for this release #. `@rcomer`_ clarified instructions for updating gallery tests. (:pull:`5100`) +#. `@rcomer`_ linked the :obj:`~iris.analysis.PERCENTILE` aggregator from the + :obj:`~iris.analysis.MEDIAN` docstring, noting that the former handles lazy + data. (:pull:`5128`) + 💼 Internal =========== diff --git a/lib/iris/analysis/__init__.py b/lib/iris/analysis/__init__.py index c0f9b5b0f8..55d5d5d93e 100644 --- a/lib/iris/analysis/__init__.py +++ b/lib/iris/analysis/__init__.py @@ -1914,7 +1914,8 @@ def interp_order(length): result = cube.collapsed('longitude', iris.analysis.MEDIAN) -This aggregator handles masked data, but NOT lazy data. +This aggregator handles masked data, but NOT lazy data. For lazy aggregation, +please try :obj:`~.PERCENTILE`. """ From e1fae5ea0a163bbcfeb23f2055996b4be4cf47ac Mon Sep 17 00:00:00 2001 From: tkknight <2108488+tkknight@users.noreply.github.com> Date: Thu, 5 Jan 2023 10:33:49 +0000 Subject: [PATCH 2/2] Unpin theme (#5129) * unpin theme and set default style to light (not dark) * added whatsnew and fixed typo. * minor tweaks --- docs/src/_templates/layout.html | 2 +- docs/src/conf.py | 6 ++++++ docs/src/whatsnew/latest.rst | 3 +++ requirements/ci/py310.yml | 2 +- requirements/ci/py38.yml | 2 +- requirements/ci/py39.yml | 2 +- 6 files changed, 13 insertions(+), 4 deletions(-) diff --git a/docs/src/_templates/layout.html b/docs/src/_templates/layout.html index 9a6fe46d01..974bd12753 100644 --- a/docs/src/_templates/layout.html +++ b/docs/src/_templates/layout.html @@ -11,7 +11,7 @@
{%- endif %} diff --git a/docs/src/conf.py b/docs/src/conf.py index d1ec7bab3b..ae5a32e8a3 100644 --- a/docs/src/conf.py +++ b/docs/src/conf.py @@ -310,6 +310,9 @@ def _dotv(version): ], "use_edit_page_button": True, "show_toc_level": 1, + # Omitted `theme-switcher` below to disable it + # Info: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/light-dark.html#configure-default-theme-mode + "navbar_end": ["navbar-icon-links"], } rev_parse = run(["git", "rev-parse", "--short", "HEAD"], capture_output=True) @@ -321,6 +324,9 @@ def _dotv(version): "github_user": "scitools", "github_version": "main", "doc_path": "docs/src", + # default theme. Also disabled the button in the html_theme_options. + # Info: https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/light-dark.html#configure-default-theme-mode + "default_mode": "light", # custom "on_rtd": on_rtd, "rtd_version": rtd_version, diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 2029e24855..cf4b646841 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -68,6 +68,9 @@ This document explains the changes made to Iris for this release ================ #. `@rcomer`_ clarified instructions for updating gallery tests. (:pull:`5100`) +#. `@tkknight`_ unpinned ``pydata-sphinx-theme`` and set the default to use + the light version (not dark) while we make the docs dark mode friendly + (:pull:`5129`) #. `@rcomer`_ linked the :obj:`~iris.analysis.PERCENTILE` aggregator from the :obj:`~iris.analysis.MEDIAN` docstring, noting that the former handles lazy diff --git a/requirements/ci/py310.yml b/requirements/ci/py310.yml index 6815c7fe6d..d79015c055 100644 --- a/requirements/ci/py310.yml +++ b/requirements/ci/py310.yml @@ -48,7 +48,7 @@ dependencies: - sphinx-copybutton - sphinx-gallery >=0.11.0 - sphinx-panels - - pydata-sphinx-theme = 0.8.1 + - pydata-sphinx-theme # Temporary minimum pins. # See https://github.com/SciTools/iris/pull/5051 diff --git a/requirements/ci/py38.yml b/requirements/ci/py38.yml index 316e0868ac..b68e8ccf45 100644 --- a/requirements/ci/py38.yml +++ b/requirements/ci/py38.yml @@ -48,7 +48,7 @@ dependencies: - sphinx-copybutton - sphinx-gallery >=0.11.0 - sphinx-panels - - pydata-sphinx-theme = 0.8.1 + - pydata-sphinx-theme # Temporary minimum pins. # See https://github.com/SciTools/iris/pull/5051 diff --git a/requirements/ci/py39.yml b/requirements/ci/py39.yml index 66e22c230f..9fec76cfde 100644 --- a/requirements/ci/py39.yml +++ b/requirements/ci/py39.yml @@ -48,7 +48,7 @@ dependencies: - sphinx-copybutton - sphinx-gallery >=0.11.0 - sphinx-panels - - pydata-sphinx-theme = 0.8.1 + - pydata-sphinx-theme # Temporary minimum pins. # See https://github.com/SciTools/iris/pull/5051