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

New 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.

Internally, this extension uses Imagemagick to convert images.

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

A path to convert command. By default, the imgconverter uses the command from search paths.

On windows platform, magick command is used by default.

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

image_converter_args

Additional command-line arguments to give to convert, as a list. The default is an empty list [].

On windows platform, it defaults to ["convert"].

Changed in version 3.1: Use ["convert"] by default on windows