Skip to content

Commit

Permalink
Add addopts to configuration.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
bersbersbers authored Feb 27, 2024
1 parent 20b389c commit 42d1b7b
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -46,7 +46,7 @@ Enable baseline image generation
--------------------------------
| **kwarg**: ---
| **CLI**: ``--mpl-generate-path=<path>``
| **INI**: ---
| **INI**: ``addopts = --mpl-generate-path=<path>``
| Default: ``None``
Baseline images will be generated and saved to the specified directory path, relative to where pytest was run.
Expand All @@ -63,7 +63,7 @@ Enable baseline hash generation
-------------------------------
| **kwarg**: ---
| **CLI**: ``--mpl-generate-hash-library=<path>``
| **INI**: ---
| **INI**: ``addopts = --mpl-generate-hash-library=<path>``
| Default: ``None``
Baseline hashes will be generated and saved to the specified JSON file path, relative to where pytest was run.
Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit 42d1b7b

Please sign in to comment.