Skip to content

Commit f39478d

Browse files
committed
Mention --mpl-results-path and uploading artifacts in README
1 parent 6767c13 commit f39478d

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,22 @@ The default tolerance is 2, which is very strict. In some cases, you may
220220
want to relax this to account for differences in fonts across different
221221
systems.
222222

223+
By default, the expected, actual and difference files are written to a
224+
temporary directory with a non-deterministic path. If you want to instead
225+
write them to a specific directory, you can use::
226+
227+
py.test --mpl --mpl-results-path=results
228+
229+
The ``results`` directory will then contain one sub-directory per test, and each
230+
sub-directory will contain the three files mentioned above. If you are using a
231+
continuous integration service, you can then use the option to upload artifacts
232+
to upload these results to somewhere where you can view them. For more
233+
information, see:
234+
235+
* `Uploading artifacts on Travis-CI <https://docs.travis-ci.com/user/uploading-artifacts/>`_
236+
* `Build Artifacts (CircleCI) <https://circleci.com/docs/1.0/build-artifacts/>`_
237+
* `Packaging Artifacts (AppVeyor) <https://www.appveyor.com/docs/packaging-artifacts/>`_
238+
223239
Running the tests for pytest-mpl
224240
--------------------------------
225241

0 commit comments

Comments
 (0)