Skip to content

Commit

Permalink
DOC: improve gallery test instructions (#5100)
Browse files Browse the repository at this point in the history
  • Loading branch information
rcomer committed Dec 9, 2022
1 parent dfbc5c2 commit 6eb0401
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
10 changes: 6 additions & 4 deletions docs/src/developers_guide/contributing_documentation_full.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,8 @@ pattern matching, e.g.::

pytest -v -k plot_coriolis docs/gallery_tests/test_gallery_examples.py

If a gallery test fails, follow the instructions in :ref:`testing.graphics`.

The ``make`` commands shown below can be run in the ``docs`` or ``docs/src``
directory.

Expand Down Expand Up @@ -165,13 +167,13 @@ The code for the gallery entries are in ``docs/gallery_code``.
Each sub directory in this directory is a sub section of the gallery. The
respective ``README.rst`` in each folder is included in the gallery output.

For each gallery entry there must be a corresponding test script located in
``docs/gallery_tests``.

To add an entry to the gallery simple place your python code into the
appropriate sub directory and name it with a prefix of ``plot_``. If your
gallery entry does not fit into any existing sub directories then create a new
directory and place it in there.
directory and place it in there. A test for the gallery entry will be
automatically generated (see Testing_ for how to run it). To add a new
reference image for this test, follow the instructions in
:ref:`testing.graphics`.

The reStructuredText (rst) output of the gallery is located in
``docs/src/generated/gallery``.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/whatsnew/latest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ This document explains the changes made to Iris for this release
📚 Documentation
================

#. N/A
#. `@rcomer`_ clarified instructions for updating gallery tests. (:pull:`5100`)


💼 Internal
Expand Down

0 comments on commit 6eb0401

Please sign in to comment.