Docs

Author: Apkawa

README.md

@@ -1,6 +1,6 @@
 [![PyPi](https://img.shields.io/pypi/v/pytest-image-diff.svg)](https://pypi.python.org/pypi/pytest-image-diff)
-[![Build Status](https://travis-ci.org/Apkawa/pytest-image-diff.svg?branch=master)](https://travis-ci.org/Apkawa/pytest-image-diff)
-[![Documentation Status](https://readthedocs.org/projects/pytest-image-diff/badge/?version=latest)](https://pytest-ngrok.readthedocs.io/en/latest/?badge=latest)
+[![ci](https://github.com/Apkawa/pytest-image-diff/actions/workflows/ci.yml/badge.svg)](https://github.com/Apkawa/pytest-image-diff/actions/workflows/ci.yml)
+[![Documentation Status](https://readthedocs.org/projects/pytest-image-diff/badge/?version=latest)](https://pytest-image-diff.readthedocs.io/en/latest/?badge=latest)
 [![Codecov](https://codecov.io/gh/Apkawa/pytest-image-diff/branch/master/graph/badge.svg)](https://codecov.io/gh/Apkawa/pytest-image-diff)
 [![Requirements Status](https://requires.io/github/Apkawa/pytest-image-diff/requirements.svg?branch=master)](https://requires.io/github/Apkawa/pytest-image-diff/requirements/?branch=master)
 [![PyUP](https://pyup.io/repos/github/Apkawa/pytest-image-diff/shield.svg)](https://pyup.io/repos/github/Apkawa/pytest-image-diff)
@@ -21,12 +21,13 @@ or from git
 pip install -e git+https://githib.com/Apkawa/pytest-image-diff.git@master#egg=pytest-image-diff
 ```
 
-Python>=3.5
+Python>=3.6
 
 
 # Usage
 
 ```python
+from typing import Union
 from PIL import Image
 
 
@@ -35,7 +36,43 @@ def test_compare(image_diff):
     image2: Image or str or bytes = '/path/to/image.jpeg'
     image_diff(image, image2)
 
+
 def test_regression(image_regression):
-    image: Image or str or bytes = Image.new()
-    image_regression(image)
+    image: Union[Image, str, bytes] = Image.new()
+    image_regression(image, threshold=0.5)
+```
+
+First run creates reference images
+
+## pytest-splinter
+
+Fixture `screenshot_regression` enabled if pytest-splinter installed
+
+```python3
+import pytest
+
+@pytest.fixture
+def admin_browser(request, browser_instance_getter):
+    """Admin browser fixture."""
+    # browser_instance_getter function receives parent fixture -- our admin_browser
+    return browser_instance_getter(request, admin_browser)
+
+def test_2_browsers(browser, admin_browser, screenshot_regression):
+    """Test using 2 browsers at the same time."""
+    browser.visit('http://google.com')
+    admin_browser.visit('http://admin.example.com')
+
+    screenshot_regression(suffix="browser")
+    screenshot_regression(admin_browser, suffix="admin browser")
+
+def test_pytest_splinter(browser, screenshot_regression):
+    # Recommend fix window size for avoid regression
+    browser.driver.set_window_size(1280, 1024)
+
+    browser.visit('http://google.com')
+
+    screenshot_regression(suffix="main")
+    # ... some interaction
+    browser.click()
+    screenshot_regression(suffix="success")
 ```

docs/source/code.rst

@@ -0,0 +1,25 @@
+API Reference
+=============
+
+Config fixtures
+---------------
+
+.. autofunction:: pytest_image_diff.plugin.image_diff_threshold
+
+.. autofunction:: pytest_image_diff.plugin.image_diff_root
+.. autofunction:: pytest_image_diff.plugin.image_diff_dir
+.. autofunction:: pytest_image_diff.plugin.image_diff_reference_dir
+
+
+Fixtures
+--------
+
+.. autofunction:: pytest_image_diff.plugin.image_regression
+
+.. autofunction:: pytest_image_diff.plugin.image_diff
+
+
+pytest-splinter helper
+----------------------
+
+.. autofunction:: pytest_image_diff.plugin.screenshot_regression

docs/source/conf.py

@@ -12,22 +12,23 @@
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 #
-# import os
-# import sys
-# sys.path.insert(0, os.path.abspath('.'))
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath("../.."))
 
 
 # -- Project information -----------------------------------------------------
 
 
 project = "pytest-image-diff"
-copyright = "2020, Apkawa <[email protected]"
+copyright = "2016, Apkawa <[email protected]"
 author = "Apkawa <[email protected]"
 
 # The short X.Y version
-version = "0.0"
+version = "0.4"
 # The full version, including alpha/beta/rc tags
-release = "0.0.5"
+release = "0.4.0"
 
 # -- General configuration ---------------------------------------------------
 
@@ -38,11 +39,24 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["m2r"]
+extensions = [
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autodoc",
+    "sphinx_autodoc_typehints",
+    "sphinx_paramlinks",
+    "m2r2",
+]
+
+autodoc_member_order = "bysource"
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
 
+from recommonmark.parser import CommonMarkParser
+
+source_parsers = {".md": CommonMarkParser}
+
 source_suffix = [".rst", ".md"]
 
 # The master toctree document.
@@ -63,12 +77,12 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'alabaster'
 html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -96,7 +110,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = " pytest-image-diffdoc"
+htmlhelp_basename = project + "doc"
 
 # -- Options for LaTeX output ------------------------------------------------
 
@@ -119,22 +133,14 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (
-        master_doc,
-        " pytest-image-diff.tex",
-        " pytest-image-diff Documentation",
-        "Apkawa",
-        "manual",
-    )
+    (master_doc, project + ".tex", project + " Documentation", "Apkawa", "manual")
 ]
 
 # -- Options for manual page output ------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    (master_doc, " pytest-image-diff", " pytest-image-diff Documentation", [author], 1)
-]
+man_pages = [(master_doc, project, project + " Documentation", [author], 1)]
 
 # -- Options for Texinfo output ----------------------------------------------
 
@@ -144,10 +150,10 @@
 texinfo_documents = [
     (
         master_doc,
-        " pytest-image-diff",
-        " pytest-image-diff Documentation",
+        project,
+        project + " Documentation",
         author,
-        "pytest-image-diff",
+        project,
         "One line description of project.",
         "Miscellaneous",
     )
@@ -158,7 +164,7 @@
 
 # At the bottom of conf.py
 def setup(app):
-    git_doc_root = "https://githib.com/Apkawa/%3Cspan%20class="x x-first x-last">pytest-image-diff/blob/master/docs/"
+    git_doc_root = "https://githib.com/Apkawa/%3Cspan%20class="x x-first x-last">%s/blob/master/docs/" % project
     app.add_config_value(
         "recommonmark_config",
         {

docs/source/contributing.rst

@@ -0,0 +1,4 @@
+Contributors
+============
+
+.. mdinclude:: ../../CONTRIBUTING.md

docs/source/index.rst

@@ -1,19 +1,11 @@
-pytest-image-diff documentation!
-====================================
-
-|PyPi|
-|Build Status|
-|Documentation Status|
-|Codecov|
-|Requirements Status|
-|PyUP|
-|PyPi Python versions|
-|License|
+.. mdinclude:: ../../README.md
 
 .. toctree::
-   :maxdepth: 3
-   :caption:
-      readme
+   :maxdepth: 1
+   :caption: Contents
+
+   code
+   contributing
 
 
 Indices and tables
@@ -22,22 +14,3 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
-
-
-
-.. |PyPi| image:: https://img.shields.io/pypi/v/pytest-image-diff.svg
-   :target: https://pypi.python.org/pypi/pytest-image-diff
-.. |Build Status| image:: https://travis-ci.org/Apkawa/pytest-image-diff.svg?branch=master
-   :target: https://travis-ci.org/Apkawa/pytest-image-diff
-.. |Documentation Status| image:: https://readthedocs.org/projects/pytest-image-diff/badge/?version=latest
-   :target: https://pytest-ngrok.readthedocs.io/en/latest/?badge=latest
-.. |Codecov| image:: https://codecov.io/gh/Apkawa/pytest-image-diff/branch/master/graph/badge.svg
-   :target: https://codecov.io/gh/Apkawa/pytest-image-diff
-.. |Requirements Status| image:: https://requires.io/github/Apkawa/pytest-image-diff/requirements.svg?branch=master
-   :target: https://requires.io/github/Apkawa/pytest-image-diff/requirements/?branch=master
-.. |PyUP| image:: https://pyup.io/repos/github/Apkawa/pytest-image-diff/shield.svg
-   :target: https://pyup.io/repos/github/Apkawa/pytest-image-diff
-.. |PyPi Python versions| image:: https://img.shields.io/pypi/pyversions/pytest-image-diff.svg
-   :target: https://pypi.python.org/pypi/pytest-image-diff
-.. |License| image:: https://img.shields.io/badge/license-MIT-blue.svg
-   :target: LICENSE

docs/source/readme.rst

@@ -48,7 +48,7 @@ def image_diff_root(request: FixtureRequest) -> str:
 @pytest.fixture(scope="session")  # pragma: no cover
 def image_diff_dir(image_diff_root: str) -> str:
     """
-    Path for store diff images. by default - '.tests/image_diff/'
+    Path for store diff images. by default - '{image_diff_root}.tests/image_diff/'
     """
     return os.path.join(image_diff_root, ".tests/image_diff/")
 
@@ -112,6 +112,7 @@ def image_regression(
 ) -> Generator[ImageRegressionCallableType, None, None]:
     """
     Check regression image.
+
     :param image: `PIL.Image` or `PathLike` or `io.BinaryIO`
     :param threshold: float, by default from `image_diff_threshold`
     :param suffix: str, need for multiple checks  by one test
@@ -163,6 +164,7 @@ def image_diff(
 ) -> Generator[ImageDiffCallableType, None, None]:
     """
     Compare two image
+
     :param image: `PIL.Image` or `PathLike` or `io.BinaryIO`
     :param image2: `PIL.Image` or `PathLike` or `io.BinaryIO`
     :param threshold: float, by default from `image_diff_threshold`

pytest_image_diff/plugin.py

@@ -12,11 +12,13 @@ mock==3.0.5
 
 # Docs
 
-Sphinx
+Sphinx>=4.0
 #alabaster
-sphinx_rtd_theme
-recommonmark
-m2r
+sphinx_rtd_theme>=0.5.2
+recommonmark>=0.7.1
+m2r2
+sphinx-autodoc-typehints
+sphinx-paramlinks
 
 # QA
 pre-commit==2.13.0

requirements-dev.txt

@@ -69,9 +69,10 @@ def read(fname):
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python",
         "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.5",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
+        "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
     ],
 )