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 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/developers_guide/release.rst b/docs/src/developers_guide/release.rst index a918253ef7..dd32381a27 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,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 index fb0e93b1ae..274892f082 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 + whatsnew/whatsnew .. todolist:: \ No newline at end of file diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 383d029ccf..887250b7c7 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -171,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/index.rst b/docs/src/whatsnew/whatsnew.rst old mode 100644 new mode 100755 similarity index 76% rename from docs/src/whatsnew/index.rst rename to docs/src/whatsnew/whatsnew.rst index 949d727a99..78c0134463 --- a/docs/src/whatsnew/index.rst +++ b/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