Redirect whatsnew to latest (#4727)

* Redirect whatsnew * Get the top bar working too * Clean build with right links * Update release docs * Review fixes * update section name for clarity
SciTools · Jun 6, 2022 · 6ea8af9 · 6ea8af9
1 parent b462ddd
commit 6ea8af9
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 10 deletions.
diff --git 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

diff --git 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/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,6 +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``.
 #. Merge back to ``main``
 
 

diff --git 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
+   whatsnew/whatsnew
 
 .. todolist::
diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst
@@ -218,4 +218,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
diff --git a/docs/src/whatsnew/index.rst → docs/src/whatsnew/whatsnew.rst b/docs/src/whatsnew/index.rst → docs/src/whatsnew/whatsnew.rst
@@ -1,14 +1,15 @@
+.. include:: ../common_links.inc
+
 .. _iris_whatsnew:
 
 What's New in Iris
-******************
-
-These "What's new" pages describe the important changes between major
-Iris versions.
+------------------
 
+.. include:: latest.rst
 
 .. toctree::
    :maxdepth: 1
+   :hidden:
 
    latest.rst
    3.2.rst