diff --git a/docs/src/developers_guide/contributing_running_tests.rst b/docs/src/developers_guide/contributing_running_tests.rst index 9bc2d797bd..ab36172283 100644 --- a/docs/src/developers_guide/contributing_running_tests.rst +++ b/docs/src/developers_guide/contributing_running_tests.rst @@ -20,10 +20,13 @@ A separate repository under the `SciTools`_ organisation is used, see https://github.com/SciTools/iris-test-data. In order to run the tests with **all** the test data you must clone the -``iris-test-data`` repository and then configure your shell to ensure the Iris -tests can find it by using the shell environment variable named -**OVERRIDE_TEST_DATA_REPOSITORY**. The example command below uses -``~/projects`` as the parent directory:: +``iris-test-data`` repository and then ensure the Iris tests can access +``iris-test-data/test_data``, using one of two methods: + +* Store the path in a shell environment variable named **OVERRIDE_TEST_DATA_REPOSITORY**. +* Store the path in ``lib/iris/etc/site.cfg`` (see :mod:`iris.config` for more). + +The example command below uses ``~/projects`` as the parent directory:: cd ~/projects git clone git@github.com:SciTools/iris-test-data.git diff --git a/docs/src/whatsnew/latest.rst b/docs/src/whatsnew/latest.rst index f50a71cc82..7235957958 100644 --- a/docs/src/whatsnew/latest.rst +++ b/docs/src/whatsnew/latest.rst @@ -130,6 +130,9 @@ This document explains the changes made to Iris for this release :class:`iris.Constraint` to :ref:`userguide loading section ` and to api reference documentation. (:pull:`4321`) +#. `@trexfeathers`_ added more detail on making `iris-test-data`_ available + during :ref:`developer_running_tests`. (:pull:`4359`) + 💼 Internal =========== diff --git a/lib/iris/config.py b/lib/iris/config.py index 24fc0fc6ea..3659ac7dcd 100644 --- a/lib/iris/config.py +++ b/lib/iris/config.py @@ -8,7 +8,7 @@ The default configuration values can be overridden by creating the file ``iris/etc/site.cfg``. If it exists, this file must conform to the format -defined by :mod:`ConfigParser`. +defined by :mod:`configparser`. ----------