Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add addopts to configuration.rst #224

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add addopts to configuration.rst #224

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/configuration.rst
View file
Open in desktop
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