@@ -114,13 +114,24 @@ and the tests will pass if the images are the same. If you omit the
114114runs, without checking the output images.
115115
116116
117- Generating a Failure Summary
118- ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
117+ Generating a Test Summary
118+ ^^^^^^^^^^^^^^^^^^^^^^^^^
119119
120120By specifying the ``--mpl-generate-summary=html `` CLI argument, a HTML summary
121- page will be generated showing the baseline, diff and result image for each
122- failing test. If no baseline images are configured, just the result images will
123- be displayed. (See also, the **Results always ** section below.)
121+ page will be generated showing the result, log entry and RMS of each test,
122+ and the hashes if configured. The baseline, diff and result image for each
123+ failing test will be shown. If **Results always ** is configured
124+ (see section below), images for passing tests will also be shown.
125+ If no baseline images are configured, just the result images will
126+ be displayed.
127+
128+ +---------------+---------------+---------------+
129+ | |html all | | |html filter | | |html result | |
130+ +---------------+---------------+---------------+
131+
132+ As well as ``html ``, ``basic-html `` can be specified for an alternative HTML
133+ summary which does not rely on JavaScript or external resources. A ``json ``
134+ summary can also be saved. Multiple options can be specified comma-separated.
124135
125136Options
126137-------
@@ -301,6 +312,9 @@ install the latest version of the plugin then do::
301312The reason for having to install the plugin first is to ensure that the
302313plugin is correctly loaded as part of the test suite.
303314
315+ .. |html all | image :: images/html_all.png
316+ .. |html filter | image :: images/html_filter.png
317+ .. |html result | image :: images/html_result.png
304318.. |expected | image :: images/baseline-coords_overlay_auto_coord_meta.png
305319.. |actual | image :: images/coords_overlay_auto_coord_meta.png
306320.. |diff | image :: images/coords_overlay_auto_coord_meta-failed-diff.png
0 commit comments