From 7a1df660cf483d3b9d5d36f249171daf5cbb1664 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Tue, 3 May 2022 09:31:08 +0100 Subject: [PATCH 1/6] Redirect whatsnew --- docs/src/whatsnew/index.rst | 2 -- docs/src/whatsnew/latest.rst | 2 ++ docs/src/whatsnew/latest.rst.template | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/index.rst index 949d727a99..da8a53453e 100644 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/index.rst @@ -1,5 +1,3 @@ -.. _iris_whatsnew: - What's New in Iris ****************** diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 383d029ccf..8d880483d9 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -1,5 +1,7 @@ .. include:: ../common_links.inc +.. _iris_whatsnew: + |iris_version| |build_date| [unreleased] **************************************** diff --git a/docs/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template index 1b36d3f0b0..b11399fce1 100644 --- a/docs/src/whatsnew/latest.rst.template +++ b/docs/src/whatsnew/latest.rst.template @@ -1,5 +1,7 @@ .. include:: ../common_links.inc +.. _iris_whatsnew: + |iris_version| |build_date| [unreleased] **************************************** From 12a2eaa3a44e96d9aaa19043be16139c0b6e51bd Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Tue, 3 May 2022 12:13:02 +0100 Subject: [PATCH 2/6] Get the top bar working too --- docs/src/developers_guide/release.rst | 3 +++ docs/src/index.rst | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index a918253ef7..59e3a420ac 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -255,6 +255,9 @@ Post Release Steps `Read The Docs`_ to ensure that the appropriate versions are ``Active`` and/or ``Hidden``. To do this ``Edit`` the appropriate version e.g., see `Editing v3.0.0rc0`_ (must be logged into Read the Docs). +#. Make a new `latest.rst` from `latest.rst.template` and remove the `.. + _iris_whatsnew` from the top of the what's new for the release that has just + happened. #. Merge back to ``main`` diff --git a/docs/src/index.rst b/docs/src/index.rst index fb0e93b1ae..a6b81e802c 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -139,11 +139,11 @@ The legacy support resources: .. toctree:: - :caption: Developers Guide + :caption: What's New in Iris :maxdepth: 1 :name: whats_new_index :hidden: - whatsnew/index + What's New in Iris .. todolist:: \ No newline at end of file From 87f86116ad87ddc9bb80ea1ece0c0b1545a34c81 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Wed, 1 Jun 2022 16:57:34 +0100 Subject: [PATCH 3/6] Clean build with right links --- .../developers_guide/contributing_getting_involved.rst | 2 +- docs/src/index.rst | 2 +- docs/src/whatsnew/latest.rst | 4 +--- docs/src/whatsnew/latest.rst.template | 2 -- docs/src/whatsnew/{index.rst => whatsnew.rst} | 10 ++++++---- 5 files changed, 9 insertions(+), 11 deletions(-) rename docs/src/whatsnew/{index.rst => whatsnew.rst} (75%) mode change 100644 => 100755 diff --git a/docs/src/developers_guide/contributing_getting_involved.rst b/docs/src/developers_guide/contributing_getting_involved.rst index f4e677cea2..535b3d13bc 100644 --- a/docs/src/developers_guide/contributing_getting_involved.rst +++ b/docs/src/developers_guide/contributing_getting_involved.rst @@ -59,7 +59,7 @@ If you are new to using GitHub we recommend reading the :hidden: ../generated/api/iris - ../whatsnew/index + ../whatsnew/whatsnew ../techpapers/index ../copyright ../voted_issues diff --git a/docs/src/index.rst b/docs/src/index.rst index a6b81e802c..274892f082 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -144,6 +144,6 @@ The legacy support resources: :name: whats_new_index :hidden: - What's New in Iris + whatsnew/whatsnew .. todolist:: \ No newline at end of file diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 8d880483d9..887250b7c7 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -1,7 +1,5 @@ .. include:: ../common_links.inc -.. _iris_whatsnew: - |iris_version| |build_date| [unreleased] **************************************** @@ -173,4 +171,4 @@ This document explains the changes made to Iris for this release Whatsnew resources in alphabetical order: .. _Cell Boundaries: https://cfconventions.org/Data/cf-conventions/cf-conventions-1.9/cf-conventions.html#cell-boundaries -.. _PyData Sphinx Theme: https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html +.. _PyData Sphinx Theme: https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html \ No newline at end of file diff --git a/docs/src/whatsnew/latest.rst.template b/docs/src/whatsnew/latest.rst.template index b11399fce1..1b36d3f0b0 100644 --- a/docs/src/whatsnew/latest.rst.template +++ b/docs/src/whatsnew/latest.rst.template @@ -1,7 +1,5 @@ .. include:: ../common_links.inc -.. _iris_whatsnew: - |iris_version| |build_date| [unreleased] **************************************** diff --git a/docs/src/whatsnew/index.rst b/docs/src/whatsnew/whatsnew.rst old mode 100644 new mode 100755 similarity index 75% rename from docs/src/whatsnew/index.rst rename to docs/src/whatsnew/whatsnew.rst index da8a53453e..90727ea618 --- a/docs/src/whatsnew/index.rst +++ b/docs/src/whatsnew/whatsnew.rst @@ -1,9 +1,11 @@ -What's New in Iris -****************** +.. include:: ../common_links.inc + +.. _iris_whatsnew: -These "What's new" pages describe the important changes between major -Iris versions. +What's New in Iris +------------------ +.. include:: latest.rst .. toctree:: :maxdepth: 1 From 50ee019ce4a9f7df8f573ace9f1883daf8041767 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Wed, 1 Jun 2022 17:02:12 +0100 Subject: [PATCH 4/6] Update release docs --- docs/src/developers_guide/release.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 59e3a420ac..64d48e814f 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -221,6 +221,8 @@ Release Steps * Use ``git`` to rename ``docs/src/whatsnew/latest.rst`` to the release version file ``v1.9.rst`` + * Update ``docs/src/whatsnews/whatsnew.rst`` to rename ``latest.rst`` in the + include statement and toctree. * Use ``git`` to delete the ``docs/src/whatsnew/latest.rst.template`` file * In ``v1.9.rst`` remove the ``[unreleased]`` caption from the page title. Note that, the Iris version and release date are updated automatically @@ -255,9 +257,8 @@ Post Release Steps `Read The Docs`_ to ensure that the appropriate versions are ``Active`` and/or ``Hidden``. To do this ``Edit`` the appropriate version e.g., see `Editing v3.0.0rc0`_ (must be logged into Read the Docs). -#. Make a new `latest.rst` from `latest.rst.template` and remove the `.. - _iris_whatsnew` from the top of the what's new for the release that has just - happened. +#. Make a new `latest.rst` from `latest.rst.template` and update the include + statement and the toctree in `whatsnew.rst` to point at the new `latest.rst`. #. Merge back to ``main`` From aab13c401ef69f3f359cbbcbfd9fbac11acf63ae Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Mon, 6 Jun 2022 10:01:58 +0100 Subject: [PATCH 5/6] Review fixes --- docs/src/developers_guide/release.rst | 5 +++-- docs/src/whatsnew/whatsnew.rst | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 64d48e814f..dd32381a27 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -257,8 +257,9 @@ Post Release Steps `Read The Docs`_ to ensure that the appropriate versions are ``Active`` and/or ``Hidden``. To do this ``Edit`` the appropriate version e.g., see `Editing v3.0.0rc0`_ (must be logged into Read the Docs). -#. Make a new `latest.rst` from `latest.rst.template` and update the include - statement and the toctree in `whatsnew.rst` to point at the new `latest.rst`. +#. Make a new ``latest.rst`` from ``latest.rst.template`` and update the include + statement and the toctree in ``whatsnew.rst`` to point at the new + ``latest.rst``. #. Merge back to ``main`` diff --git a/docs/src/whatsnew/whatsnew.rst b/docs/src/whatsnew/whatsnew.rst index 90727ea618..78c0134463 100755 --- a/docs/src/whatsnew/whatsnew.rst +++ b/docs/src/whatsnew/whatsnew.rst @@ -9,6 +9,7 @@ What's New in Iris .. toctree:: :maxdepth: 1 + :hidden: latest.rst 3.2.rst From 9ccf756159376405981c82ae84e6b5986e996cd8 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Mon, 6 Jun 2022 10:02:15 +0100 Subject: [PATCH 6/6] update section name for clarity --- docs/src/developers_guide/contributing_codebase_index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/src/developers_guide/contributing_codebase_index.rst b/docs/src/developers_guide/contributing_codebase_index.rst index 88986c0c7a..b59a196ff0 100644 --- a/docs/src/developers_guide/contributing_codebase_index.rst +++ b/docs/src/developers_guide/contributing_codebase_index.rst @@ -1,7 +1,7 @@ .. _contributing.documentation.codebase: -Contributing to the Code Base -============================= +Working with the Code Base +========================== .. toctree:: :maxdepth: 3