From 855936a015d05b5c38cde682935f636c461e62c6 Mon Sep 17 00:00:00 2001 From: tkknight <2108488+tkknight@users.noreply.github.com> Date: Tue, 22 Sep 2020 09:56:34 +0100 Subject: [PATCH 1/2] Whats new for pr3871 (#3875) * Added whats new for pr3871 * Added line feed --- docs/iris/src/common_links.inc | 2 ++ docs/iris/src/whatsnew/latest.rst | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/docs/iris/src/common_links.inc b/docs/iris/src/common_links.inc index 420186cf50..acb6a1ece8 100644 --- a/docs/iris/src/common_links.inc +++ b/docs/iris/src/common_links.inc @@ -22,3 +22,5 @@ .. _New Issue: https://github.com/scitools/iris/issues/new/choose .. _matplotlib: https://matplotlib.org/ .. _conda: https://docs.conda.io/en/latest/ +.. _sphinx: https://www.sphinx-doc.org/en/master/ +.. _napolean: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html diff --git a/docs/iris/src/whatsnew/latest.rst b/docs/iris/src/whatsnew/latest.rst index be4062b788..cd96208365 100644 --- a/docs/iris/src/whatsnew/latest.rst +++ b/docs/iris/src/whatsnew/latest.rst @@ -247,6 +247,10 @@ This document explains the changes made to Iris for this release refused and thus travis-ci_ job failures. For more information on linkcheck, see :ref:`contributing.documentation.testing`. (:pull:`3873`) +* `@tkknight`_ enabled the napolean_ package that is used by sphinx_ to cater + for the existing google style docstrings and to also allow for numpy + docstrings. This resolves :issue:`3841`. (:pull:`3871`) + 💼 Internal =========== From 625b81ca8b6b261bc0ddf4529c4f5f12e3410f1f Mon Sep 17 00:00:00 2001 From: tkknight <2108488+tkknight@users.noreply.github.com> Date: Tue, 22 Sep 2020 10:27:19 +0100 Subject: [PATCH 2/2] Added include for common links file (#3876) --- docs/iris/src/whatsnew/latest.rst.template | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/iris/src/whatsnew/latest.rst.template b/docs/iris/src/whatsnew/latest.rst.template index 8ea068f25f..67518e539a 100644 --- a/docs/iris/src/whatsnew/latest.rst.template +++ b/docs/iris/src/whatsnew/latest.rst.template @@ -1,3 +1,5 @@ +.. include:: ../common_links.inc + ************