From 4176d1566357a96b5b5c957b24a232f78bf9ca01 Mon Sep 17 00:00:00 2001 From: Martin Yeo <40734014+trexfeathers@users.noreply.github.com> Date: Thu, 17 Nov 2022 15:35:54 +0000 Subject: [PATCH] Documentation updates for `v3.4.0rc0` release. (#5078) * Finalise v3.4 What's New. * Update What's New index. * 3.4 what's new small search engine change. * Hard-coded release information in What's New. --- docs/src/whatsnew/{latest.rst => 3.4.rst} | 28 ++++-- docs/src/whatsnew/index.rst | 4 +- docs/src/whatsnew/latest.rst.template | 112 ---------------------- 3 files changed, 23 insertions(+), 121 deletions(-) rename docs/src/whatsnew/{latest.rst => 3.4.rst} (90%) delete mode 100644 docs/src/whatsnew/latest.rst.template diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/3.4.rst similarity index 90% rename from docs/src/whatsnew/latest.rst rename to docs/src/whatsnew/3.4.rst index fe30828d83..f34fd25904 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/3.4.rst @@ -1,7 +1,7 @@ .. include:: ../common_links.inc -|iris_version| |build_date| [unreleased] -**************************************** +v3.4 (17 Nov 2022) [release candidate] +************************************** This document explains the changes made to Iris for this release (:doc:`View all changes `.) @@ -14,9 +14,22 @@ This document explains the changes made to Iris for this release :animate: fade-in :open: - The highlights for this major/minor release of Iris include: - - * N/A + The highlights for this minor release of Iris include: + + * We have **archived older Iris documentation** - everything before + ``v3.0.0`` - so older versions will soon no longer appear in search + engines. If you need this older documentation: please + see :ref:`iris_support`. + * We have added a :ref:`glossary` to the Iris documentation. + * We have completed work to make **Pandas interoperability** handle + n-dimensional :class:`~iris.cube.Cube`\s. + * We have **begun refactoring Iris' regridding**, which has already improved + performance and functionality, with more potential in future! + * We have made several other significant `🚀 Performance Enhancements`_. + * Please note that **Iris cannot currently work with the latest NetCDF4 + releases**. The pin is set to ``` if you have any issues or feature requests for improving Iris. Enjoy! @@ -226,8 +239,9 @@ This document explains the changes made to Iris for this release #. `@tkknight`_ updated the links for the Iris documentation to v2.4 and earlier to point to the archive of zip files instead. (:pull:`5064`) -#. `@Esadek-MO`_ added notes at the bottom of functions to - to clarify if the function preserves laziness or not. (:pull:`5066`) +#. `@Esadek-MO`_ began adding notes at the bottom of functions to + to clarify if the function preserves laziness or not. See :issue:`3292` for + the ongoing checklist. (:pull:`5066`) 💼 Internal =========== diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst index 8cff21f32f..e5da025691 100644 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/index.rst @@ -5,13 +5,13 @@ What's New in Iris ------------------ -.. include:: latest.rst +.. include:: 3.4.rst .. toctree:: :maxdepth: 1 :hidden: - latest.rst + 3.4.rst 3.3.rst 3.2.rst 3.1.rst diff --git a/docs/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template deleted file mode 100644 index 661ee47f50..0000000000 --- a/docs/src/whatsnew/latest.rst.template +++ /dev/null @@ -1,112 +0,0 @@ -.. include:: ../common_links.inc - -|iris_version| |build_date| [unreleased] -**************************************** - -This document explains the changes made to Iris for this release -(:doc:`View all changes `.) - - -.. dropdown:: :opticon:`report` |iris_version| Release Highlights - :container: + shadow - :title: text-primary text-center font-weight-bold - :body: bg-light - :animate: fade-in - :open: - - The highlights for this major/minor release of Iris include: - - * N/A - - And finally, get in touch with us on :issue:`GitHub` if you have - any issues or feature requests for improving Iris. Enjoy! - - -NOTE: section below is a template for bugfix patches -==================================================== - (Please remove this section when creating an initial 'latest.rst') - -v3.X.X (DD MMM YYYY) -==================== - -.. dropdown:: :opticon:`alert` v3.X.X Patches - :container: + shadow - :title: text-primary text-center font-weight-bold - :body: bg-light - :animate: fade-in - - The patches in this release of Iris include: - - #. N/A - -NOTE: section above is a template for bugfix patches -==================================================== - (Please remove this section when creating an initial 'latest.rst') - - - -📢 Announcements -================ - -#. N/A - - -✨ Features -=========== - -#. N/A - - -🐛 Bugs Fixed -============= - -#. N/A - - -💣 Incompatible Changes -======================= - -#. N/A - - -🚀 Performance Enhancements -=========================== - -#. N/A - - -🔥 Deprecations -=============== - -#. N/A - - -🔗 Dependencies -=============== - -#. N/A - - -📚 Documentation -================ - -#. N/A - - -💼 Internal -=========== - -#. N/A - - -.. comment - Whatsnew author names (@github name) in alphabetical order. Note that, - core dev names are automatically included by the common_links.inc: - - - - -.. comment - Whatsnew resources in alphabetical order: - -