From 42d1b7b8fb24ca86eb6c481325c6994ef79d0daf Mon Sep 17 00:00:00 2001 From: bersbersbers <12128514+bersbersbers@users.noreply.github.com> Date: Tue, 27 Feb 2024 19:58:22 +0100 Subject: [PATCH] Add `addopts` to `configuration.rst` --- docs/configuration.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index 1afce3a..b4cd65f 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -27,7 +27,7 @@ Enable testing -------------- | **kwarg**: --- | **CLI**: ``--mpl`` -| **INI**: --- +| **INI**: ``addopts = --mpl`` | Default: ``False`` To enable image comparison testing, pass ``--mpl`` when running pytest. @@ -46,7 +46,7 @@ Enable baseline image generation -------------------------------- | **kwarg**: --- | **CLI**: ``--mpl-generate-path=`` -| **INI**: --- +| **INI**: ``addopts = --mpl-generate-path=`` | Default: ``None`` Baseline images will be generated and saved to the specified directory path, relative to where pytest was run. @@ -63,7 +63,7 @@ Enable baseline hash generation ------------------------------- | **kwarg**: --- | **CLI**: ``--mpl-generate-hash-library=`` -| **INI**: --- +| **INI**: ``addopts = --mpl-generate-hash-library=`` | Default: ``None`` Baseline hashes will be generated and saved to the specified JSON file path, relative to where pytest was run. @@ -116,7 +116,7 @@ Whether ``--mpl-baseline-path`` should also be relative to the test file ------------------------------------------------------------------------ | **kwarg**: --- | **CLI**: ``--mpl-baseline-relative`` -| **INI**: --- +| **INI**: ``addopts = --mpl-baseline-relative`` | Default: ``False`` If this option is set, the baseline directory specified by ``--mpl-baseline-path`` will be interpreted as being relative to the test file.