# sphinx_gallery.scrapers

## Scrapers for embedding images

Collect images that have been produced by code blocks.

The only scrapers we support are Matplotlib and Mayavi, others should live in modules that will support them (e.g., PyVista, Plotly).

### Functions

`sphinx_gallery.scrapers.``clean_modules`(gallery_conf, fname)

  Remove, unload, or reset modules after running each example.

  After a script is executed it can load a variety of settings that one does not want to influence in other examples in the gallery.

  Parameters

    - gallery_conf (dict) – The gallery configuration.

    - fname (str or None) – The example being run. Will be None when this is called entering a directory of examples to be built.

#### Examples using `sphinx_gallery.scrapers.clean_modules`

`sphinx_gallery.scrapers.``figure_rst`(figure_list, sources_dir, fig_titles='')

  Generate RST for a list of image filenames.

  Depending on whether we have one or more figures, we use a single rst call to ‘image’ or a horizontal list.

  Parameters

    - figure_list (list) – List of strings of the figures’ absolute paths.

    - sources_dir (str) – absolute path of Sphinx documentation sources

    - fig_titles (str) – Titles of figures, empty string if no titles found. Currently only supported for matplotlib figures, default = ‘’.

  Returns

    images_rst – rst code to embed the images in the document

  Return type

    str

#### Examples using `sphinx_gallery.scrapers.figure_rst`

`sphinx_gallery.scrapers.``matplotlib_scraper`(block, block_vars, gallery_conf, **kwargs)

  Scrape Matplotlib images.

  Parameters

    - block (tuple) – A tuple containing the (label, content, line_number) of the block.

    - block_vars (dict) – Dict of block variables.

    - gallery_conf (dict) – Contains the configuration of Sphinx-Gallery

    - **kwargs (dict) – Additional keyword arguments to pass to `savefig()`, e.g. `format='svg'`. The `format` kwarg in particular is used to set the file extension of the output file (currently only ‘png’, ‘jpg’, and ‘svg’ are supported).

  Returns

    rst – The ReSTructuredText that will be rendered to HTML containing the images. This is often produced by `figure_rst()`.

  Return type

    str

#### Examples using `sphinx_gallery.scrapers.matplotlib_scraper`

`sphinx_gallery.scrapers.``mayavi_scraper`(block, block_vars, gallery_conf)

  Scrape Mayavi images.

  Parameters

    - block (tuple) – A tuple containing the (label, content, line_number) of the block.

    - block_vars (dict) – Dict of block variables.

    - gallery_conf (dict) – Contains the configuration of Sphinx-Gallery

  Returns

    rst – The ReSTructuredText that will be rendered to HTML containing the images. This is often produced by `figure_rst()`.

  Return type

    str

#### Examples using `sphinx_gallery.scrapers.mayavi_scraper`

`sphinx_gallery.scrapers.``save_figures`(block, block_vars, gallery_conf)

  Save all open figures of the example code-block.

  Parameters

    - block (tuple) – A tuple containing the (label, content, line_number) of the block.

    - block_vars (dict) – Dict of block variables.

    - gallery_conf (dict) – Contains the configuration of Sphinx-Gallery

  Returns

    images_rst – rst code to embed the images in the document.

  Return type

    str

#### Examples using `sphinx_gallery.scrapers.save_figures`

### Classes

class `sphinx_gallery.scrapers.``ImagePathIterator`(image_path)

  Iterate over image paths for a given example.

  Parameters

    image_path (str) – The template image path.

#### Examples using `sphinx_gallery.scrapers.ImagePathIterator`