Added demonstration images to docs

python-pillow · Sep 26, 2023 · 08c69ba · 08c69ba
1 parent 80dbd3b
commit 08c69ba
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 4 deletions.
diff --git a/docs/example/imageops_contain.png b/docs/example/imageops_contain.png
diff --git a/docs/example/imageops_cover.png b/docs/example/imageops_cover.png
diff --git a/docs/example/imageops_fit.png b/docs/example/imageops_fit.png
diff --git a/docs/example/imageops_pad.png b/docs/example/imageops_pad.png
diff --git a/docs/reference/ImageOps.rst b/docs/reference/ImageOps.rst
@@ -12,19 +12,41 @@ only work on L and RGB images.
 
 .. autofunction:: autocontrast
 .. autofunction:: colorize
-.. autofunction:: contain
-.. autofunction:: cover
-.. autofunction:: pad
 .. autofunction:: crop
 .. autofunction:: scale
 .. autofunction:: deform
 .. autofunction:: equalize
 .. autofunction:: expand
-.. autofunction:: fit
 .. autofunction:: flip
 .. autofunction:: grayscale
 .. autofunction:: invert
 .. autofunction:: mirror
 .. autofunction:: posterize
 .. autofunction:: solarize
 .. autofunction:: exif_transpose
+
+Resize relative to a given size
+-------------------------------
+
+::
+
+    from PIL import Image, ImageOps
+    size = (100, 150)
+    with Image.open("Tests/images/hopper.png") as im:
+        ImageOps.contain(im, size).save("imageops_contain.png")
+        ImageOps.cover(im, size).save("imageops_cover.png")
+        ImageOps.fit(im, size).save("imageops_fit.png")
+        ImageOps.pad(im, size, color="#f00").save("imageops_pad.png")
+
++------+--------------------------------------------+------------------------------------------+----------------------------------------+----------------------------------------+
+|      | :meth:`contain`                            | :meth:`cover`                            | :meth:`fit`                            | :meth:`pad`                            |
++======+============================================+==========================================+========================================+========================================+
+|Size  | (100, 100)                                 | (150, 150)                               | (150, 100)                             | (150, 100)                             |
++------+--------------------------------------------+------------------------------------------+----------------------------------------+----------------------------------------+
+|Image | .. image:: ../example/imageops_contain.png | .. image:: ../example/imageops_cover.png | .. image:: ../example/imageops_fit.png | .. image:: ../example/imageops_pad.png |
++------+------------+-------------------------------+------------------------------------------+----------------------------------------+----------------------------------------+
+
+.. autofunction:: contain
+.. autofunction:: cover
+.. autofunction:: fit
+.. autofunction:: pad