@emmanuelle @banesullivan let me know if these docs look good to you:

https://880-25860190-gh.circle-artifacts.com/0/rtd_html/configuration.html#image-scrapers
https://880-25860190-gh.circle-artifacts.com/0/rtd_html/advanced.html#integrate-custom-scrapers-with-sphinx-gallery

Once you've implemented the private interface in the modules in the external list, it would be nice to say they can be used by just doing 'image_scrapers': ['pyvista'] or ['plotly']. So please feel free to make a PR to SG to add a note about this once it's implemented.

Codecov Report

Merging #494 into master will decrease coverage by 0.03%.
The diff coverage is 92.3%.

@@            Coverage Diff             @@
##           master     #494      +/-   ##
==========================================
- Coverage   96.34%   96.31%   -0.04%     
==========================================
  Files          29       29              
  Lines        2681     2711      +30     
==========================================
+ Hits         2583     2611      +28     
- Misses         98      100       +2

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 8c630d0...4882cc3. Read the comment docs.

Looks good to me! I just added _get_sg_image_scraper to the master branch of PyVista so this will be live on our next release!

Cool. @choldgraf you okay with the updated docs and functionality? Here is what pyvista did to make it work (assuming @banesullivan tested it locally and it did indeed work):

https://github.com/pyvista/pyvista/blob/master/pyvista/__init__.py#L34
https://github.com/pyvista/pyvista/blob/master/pyvista/sphinx_gallery.py#L10-L18

(assuming @banesullivan tested it locally and it did indeed work)

Tested in pyvista/pyvista@d474c94

I meant with the nicer syntax 'image_scrapers': ['pyvista'] (while on this branch)

Thanks @larsoner ! Looks good to me.

I meant with the nicer syntax 'image_scrapers': ['pyvista'] (while on this branch)

Tested and working on a separate branch shown in my last linked commit ^^^ https://travis-ci.org/pyvista/pyvista/builds/534954544

Okay it's in, @banesullivan after you integrate and release, feel free to open a PR here to update the instructions to say 'pyvista' works

Okay it's in, @banesullivan after you integrate and release, feel free to open a PR here to update the instructions to say 'pyvista' works

@larsoner: PyVista 0.20.3 is out with the _get_sg_image_scraper method imlemented. I'm a bit confused on what I need to do here on the SG side... tips?

First make sure the string actually works in your builds. Then update the docs to say something like:

From PyVista 0.20.3 on, you can simply use 'image_scrapers': ('pyvista',) to scrape PyVista images

(update the SG gallery docs in the image scrapers section I mean)

Also maybe we should now break up the section a bit. Let me try