Skip to content

Commit 6ea8af9

Browse files
authored
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
1 parent b462ddd commit 6ea8af9

File tree

6 files changed

+16
-10
lines changed

6 files changed

+16
-10
lines changed

docs/src/developers_guide/contributing_codebase_index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. _contributing.documentation.codebase:
22

3-
Contributing to the Code Base
4-
=============================
3+
Working with the Code Base
4+
==========================
55

66
.. toctree::
77
:maxdepth: 3

docs/src/developers_guide/contributing_getting_involved.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ If you are new to using GitHub we recommend reading the
5959
:hidden:
6060

6161
../generated/api/iris
62-
../whatsnew/index
62+
../whatsnew/whatsnew
6363
../techpapers/index
6464
../copyright
6565
../voted_issues

docs/src/developers_guide/release.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,8 @@ Release Steps
221221

222222
* Use ``git`` to rename ``docs/src/whatsnew/latest.rst`` to the release
223223
version file ``v1.9.rst``
224+
* Update ``docs/src/whatsnews/whatsnew.rst`` to rename ``latest.rst`` in the
225+
include statement and toctree.
224226
* Use ``git`` to delete the ``docs/src/whatsnew/latest.rst.template`` file
225227
* In ``v1.9.rst`` remove the ``[unreleased]`` caption from the page title.
226228
Note that, the Iris version and release date are updated automatically
@@ -255,6 +257,9 @@ Post Release Steps
255257
`Read The Docs`_ to ensure that the appropriate versions are ``Active``
256258
and/or ``Hidden``. To do this ``Edit`` the appropriate version e.g.,
257259
see `Editing v3.0.0rc0`_ (must be logged into Read the Docs).
260+
#. Make a new ``latest.rst`` from ``latest.rst.template`` and update the include
261+
statement and the toctree in ``whatsnew.rst`` to point at the new
262+
``latest.rst``.
258263
#. Merge back to ``main``
259264

260265

docs/src/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,11 @@ The legacy support resources:
139139

140140

141141
.. toctree::
142-
:caption: Developers Guide
142+
:caption: What's New in Iris
143143
:maxdepth: 1
144144
:name: whats_new_index
145145
:hidden:
146146

147-
whatsnew/index
147+
whatsnew/whatsnew
148148

149149
.. todolist::

docs/src/whatsnew/latest.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,4 +218,4 @@ This document explains the changes made to Iris for this release
218218
Whatsnew resources in alphabetical order:
219219
220220
.. _Cell Boundaries: https://cfconventions.org/Data/cf-conventions/cf-conventions-1.9/cf-conventions.html#cell-boundaries
221-
.. _PyData Sphinx Theme: https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html
221+
.. _PyData Sphinx Theme: https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html

docs/src/whatsnew/index.rst renamed to docs/src/whatsnew/whatsnew.rst

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
1+
.. include:: ../common_links.inc
2+
13
.. _iris_whatsnew:
24

35
What's New in Iris
4-
******************
5-
6-
These "What's new" pages describe the important changes between major
7-
Iris versions.
6+
------------------
87

8+
.. include:: latest.rst
99

1010
.. toctree::
1111
:maxdepth: 1
12+
:hidden:
1213

1314
latest.rst
1415
3.2.rst

0 commit comments

Comments
 (0)