Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Redirect whatsnew to latest #4727

Merged
merged 6 commits into from
Jun 6, 2022
+16 −10
Merged

Redirect whatsnew to latest #4727

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7a1df66
Redirect whatsnew
May 3, 2022
12a2eaa
Get the top bar working too
May 3, 2022
87f8611
Clean build with right links
Jun 1, 2022
50ee019
Update release docs
Jun 1, 2022
aab13c4
Review fixes
Jun 6, 2022
9ccf756
update section name for clarity
Jun 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/developers_guide/contributing_getting_involved.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 4 additions & 0 deletions docs/src/developers_guide/release.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -255,6 +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 update the include
statement and the toctree in `whatsnew.rst` to point at the new `latest.rst`.
#. Merge back to ``main``


Expand Down
4 changes: 2 additions & 2 deletions docs/src/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::
2 changes: 1 addition & 1 deletion docs/src/whatsnew/latest.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
8 changes: 4 additions & 4 deletions docs/src/whatsnew/index.rst → docs/src/whatsnew/whatsnew.rst
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
.. 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
Expand Down