Add SG contractual method per sphinx-gallery/sphinx-gallery#494

banesullivan · banesullivan · commit fa897774ca3f · 2019-05-20T14:05:03.000-04:00
diff --git a/pyvista/sphinx_gallery.py b/pyvista/sphinx_gallery.py
@@ -7,6 +7,17 @@
 import pyvista
 
 
+def _get_sg_image_scraper():
+    """Returns the callable scraper to be used by Sphinx-Gallery which allows
+    PyVista users to just use strings as they already can for 'matplotlib' and
+    'mayavi'. Details on this implementation can be found in
+    `sphinx-gallery/sphinx-gallery/494`_
+
+    .. _sphinx-gallery/sphinx-gallery/494: https://github.com/sphinx-gallery/sphinx-gallery/pull/494
+    """
+    return Scraper()
+
+
 class Scraper(object):
     """
     Save ``pyvista.Plotter`` objects.
