Sphinx

# `sphinx.ext.imgconverter` – A reference image converter using Imagemagick

Added in version 1.6.

This extension converts images in your document to appropriate format for builders. For example, it allows you to use SVG images with LaTeX builder. As a result, you don’t mind what image format the builder supports.

By default the extension uses ImageMagick to perform conversions, and will not work if ImageMagick is not installed.

Note

ImageMagick rasterizes a SVG image on conversion. As a result, the image becomes not scalable. To avoid that, please use other image converters like sphinxcontrib-svg2pdfconverter (which uses Inkscape or `rsvg-convert`).

## Configuration

image_converter
  Type:
    `str`
  Default:
    `'convert'` on Unix; `'magick'` on Windows

  A path to a conversion command. By default, the imgconverter finds the command from search paths.

  Changed in version 3.1: Use magick command by default on windows

image_converter_args
  Type:
    `Sequence[str]`
  Default:
    `['convert']` on Windows; `()` on Unix

  Additional command-line arguments to give to convert, as a list.

  Changed in version 3.1: Use `['convert']` by default on Windows