From b43f6c2584c855284a6a76478587e4f2a78ab472 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Mon, 6 Jun 2022 16:10:27 +0100 Subject: [PATCH 1/3] Fix whatsnew --- docs/src/whatsnew/3.0.rst | 15 ++++++++------- docs/src/whatsnew/whatsnew.rst | 0 2 files changed, 8 insertions(+), 7 deletions(-) mode change 100755 => 100644 docs/src/whatsnew/whatsnew.rst diff --git a/docs/src/whatsnew/3.0.rst b/docs/src/whatsnew/3.0.rst index 771a602954..6113eaa815 100644 --- a/docs/src/whatsnew/3.0.rst +++ b/docs/src/whatsnew/3.0.rst @@ -435,13 +435,14 @@ v3.0.4 (22 July 2021) code format correction for most IDEs. See the new developer guide section on :ref:`code_formatting`. (:pull:`3518`) -#. `@tkknight`_ and `@trexfeathers`_ refreshed the :ref:`whats_new_contributions` - for the :ref:`iris_whatsnew`. This includes always creating the ``latest`` - what's new page so it appears on the latest documentation at - https://scitools-iris.readthedocs.io/en/latest/whatsnew. This resolves - :issue:`2104`, :issue:`3451`, :issue:`3818`, :issue:`3837`. Also updated the - :ref:`iris_development_releases_steps` to follow when making a release. - (:pull:`3769`, :pull:`3838`, :pull:`3843`) +#. `@tkknight`_ and `@trexfeathers`_ refreshed the + :ref:`whats_new_contributions` for the :ref:`iris_whatsnew`. This includes + always creating the ``latest`` what's new page so it appears on the latest + documentation at + https://scitools-iris.readthedocs.io/en/latest/whatsnew/whatsnew.html. This + resolves :issue:`2104`, :issue:`3451`, :issue:`3818`, :issue:`3837`. Also + updated the :ref:`iris_development_releases_steps` to follow when making a + release. (:pull:`3769`, :pull:`3838`, :pull:`3843`) #. `@tkknight`_ enabled the PDF creation of the documentation on the `Read the Docs`_ service. The PDF may be accessed by clicking on the version diff --git a/docs/src/whatsnew/whatsnew.rst b/docs/src/whatsnew/whatsnew.rst old mode 100755 new mode 100644 From 8cd98c3ab8d8529fe8926d8bdaa5af76725f60d3 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Mon, 6 Jun 2022 17:13:09 +0100 Subject: [PATCH 2/3] Instead of changing 3.0.rst, rename 'whatsnew.rst' to 'index.rst' --- .../contributing_getting_involved.rst | 2 +- docs/src/developers_guide/release.rst | 2 +- docs/src/index.rst | 2 +- docs/src/whatsnew/3.0.rst | 15 +++++++-------- docs/src/whatsnew/{whatsnew.rst => index.rst} | 0 5 files changed, 10 insertions(+), 11 deletions(-) rename docs/src/whatsnew/{whatsnew.rst => index.rst} (100%) diff --git a/docs/src/developers_guide/contributing_getting_involved.rst b/docs/src/developers_guide/contributing_getting_involved.rst index 535b3d13bc..f4e677cea2 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/whatsnew + ../whatsnew/index ../techpapers/index ../copyright ../voted_issues diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index dd32381a27..9b31dfebd7 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -258,7 +258,7 @@ Post Release Steps 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 + statement and the toctree in ``index.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 274892f082..b9f7faaa03 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -144,6 +144,6 @@ The legacy support resources: :name: whats_new_index :hidden: - whatsnew/whatsnew + whatsnew/index .. todolist:: \ No newline at end of file diff --git a/docs/src/whatsnew/3.0.rst b/docs/src/whatsnew/3.0.rst index 6113eaa815..771a602954 100644 --- a/docs/src/whatsnew/3.0.rst +++ b/docs/src/whatsnew/3.0.rst @@ -435,14 +435,13 @@ v3.0.4 (22 July 2021) code format correction for most IDEs. See the new developer guide section on :ref:`code_formatting`. (:pull:`3518`) -#. `@tkknight`_ and `@trexfeathers`_ refreshed the - :ref:`whats_new_contributions` for the :ref:`iris_whatsnew`. This includes - always creating the ``latest`` what's new page so it appears on the latest - documentation at - https://scitools-iris.readthedocs.io/en/latest/whatsnew/whatsnew.html. This - resolves :issue:`2104`, :issue:`3451`, :issue:`3818`, :issue:`3837`. Also - updated the :ref:`iris_development_releases_steps` to follow when making a - release. (:pull:`3769`, :pull:`3838`, :pull:`3843`) +#. `@tkknight`_ and `@trexfeathers`_ refreshed the :ref:`whats_new_contributions` + for the :ref:`iris_whatsnew`. This includes always creating the ``latest`` + what's new page so it appears on the latest documentation at + https://scitools-iris.readthedocs.io/en/latest/whatsnew. This resolves + :issue:`2104`, :issue:`3451`, :issue:`3818`, :issue:`3837`. Also updated the + :ref:`iris_development_releases_steps` to follow when making a release. + (:pull:`3769`, :pull:`3838`, :pull:`3843`) #. `@tkknight`_ enabled the PDF creation of the documentation on the `Read the Docs`_ service. The PDF may be accessed by clicking on the version diff --git a/docs/src/whatsnew/whatsnew.rst b/docs/src/whatsnew/index.rst similarity index 100% rename from docs/src/whatsnew/whatsnew.rst rename to docs/src/whatsnew/index.rst From 13c6c55ddba81015406bac527af93898b7e16700 Mon Sep 17 00:00:00 2001 From: Will Benfold Date: Mon, 6 Jun 2022 17:20:15 +0100 Subject: [PATCH 3/3] Missed one --- docs/src/developers_guide/release.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developers_guide/release.rst b/docs/src/developers_guide/release.rst index 9b31dfebd7..b2de9106a2 100644 --- a/docs/src/developers_guide/release.rst +++ b/docs/src/developers_guide/release.rst @@ -221,7 +221,7 @@ 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 + * Update ``docs/src/whatsnews/index.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.