From b2f441e98280f6d6eac15a8597e97aba791d9656 Mon Sep 17 00:00:00 2001 From: Tremain Knight <2108488+tkknight@users.noreply.github.com> Date: Tue, 22 Sep 2020 09:33:54 +0100 Subject: [PATCH 1/2] Added whats new for pr3871 --- 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..d7c6cb2256 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 \ No newline at end of file diff --git a/docs/iris/src/whatsnew/latest.rst b/docs/iris/src/whatsnew/latest.rst index 9f2c77ebdb..449cc98d08 100644 --- a/docs/iris/src/whatsnew/latest.rst +++ b/docs/iris/src/whatsnew/latest.rst @@ -239,6 +239,10 @@ This document explains the changes made to Iris for this release * `@rcomer`_ added argument descriptions to the :class:`~iris.coords.DimCoord` docstring. (:pull:`3681`) +* `@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 d42ccf8c1c985f19b201a49142f3653b206abf7f Mon Sep 17 00:00:00 2001 From: Tremain Knight <2108488+tkknight@users.noreply.github.com> Date: Tue, 22 Sep 2020 09:40:00 +0100 Subject: [PATCH 2/2] Added line feed --- docs/iris/src/common_links.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/iris/src/common_links.inc b/docs/iris/src/common_links.inc index d7c6cb2256..acb6a1ece8 100644 --- a/docs/iris/src/common_links.inc +++ b/docs/iris/src/common_links.inc @@ -23,4 +23,4 @@ .. _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 \ No newline at end of file +.. _napolean: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/sphinxcontrib.napoleon.html