Skip to content

Migrate docs from README.rst to website #199

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

Merged
merged 7 commits into from
Apr 22, 2023
Merged

Migrate docs from README.rst to website #199

Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
9edc946
Migrate docs from README to website
ConorMacBride Apr 5, 2023
4f448e3
Write a new README.rst
ConorMacBride Apr 5, 2023
fc450a1
Add plugin description to index
ConorMacBride Apr 6, 2023
e3cdff0
Make example commands multiline
ConorMacBride Apr 6, 2023
04e9c20
Document configuration options
ConorMacBride Apr 6, 2023
1dce0de
Add how-to guides
ConorMacBride Apr 8, 2023
bc8108b
Fixes for some issues
ConorMacBride Apr 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add plugin description to index
  • Loading branch information
@ConorMacBride
ConorMacBride committed Apr 6, 2023
commit fc450a10130dd39d4fa3a052511f22eb2110322f
6 changes: 5 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@
pytest-mpl |release| documentation
##################################

This is a plugin to facilitate image comparison for Matplotlib figures in pytest.
``pytest-mpl`` is a `pytest <https://docs.pytest.org>`__ plugin to facilitate image comparison for `Matplotlib <http://www.matplotlib.org>`__ figures.

For each figure to test, an image is generated and then subtracted from an existing reference image.
If the RMS of the residual is larger than a user-specified tolerance, the test will fail.
Alternatively, the generated image can be hashed and compared to an expected value.

************
Installation
Expand Down