diff --git a/docs/src/userguide/citation.rst b/docs/src/userguide/citation.rst index 4782e775c4..d0496f4876 100644 --- a/docs/src/userguide/citation.rst +++ b/docs/src/userguide/citation.rst @@ -7,13 +7,14 @@ Citing Iris If Iris played an important part in your research then please add us to your reference list by using the recommendations below. -IRIS can be cited directly from the `GitHub repository. `_ +Iris can be cited directly from the `GitHub repository `_ +, for more information including where to find the citation on the repo please +see the `GitHub documentation`_. -The IRIS citation does not contain the version of the software used. We +The Iris citation does not contain the version of the software used. We recommend that you use the version number of the release you used, and the -commit hash of the version you used. This will allow others to reproduce the -environment that you worked in. +commit hash if you checked out a unreleased version of Iris. This will allow +others to reproduce the environment that you worked in. You can see what a +citation should look like for a particular version of Iris, on the `GitHub documentation`_. -You can find what a citation should look like for a particular version of IRIS, -and where to find the citation on GitHub by looking at the `documentation GitHub -has for citing repositories. `_ +.. _GitHub documentation: https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files/ diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index 6ae3bfc05b..f73d6b0090 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -27,8 +27,8 @@ This document explains the changes made to Iris for this release #. `@lbdreyer`_ relicensed Iris from LGPL-3 to BSD-3. (:pull: `5577`) #. `@HGWright`_, `@bjlittle`_ and `@trexfeathers`_ (reviewers) added a - CITATION.cff file to Iris and updated the citation documentation, to help - users cite Iris in their work. (:pull:`5483`) + CITATION.cff file to Iris and updated the :ref:`citation documentation ` + , to help users cite Iris in their work. (:pull:`5483`) ✨ Features