sphinx.ext.imgconverter -- A reference image converter using Imagemagick¶
在 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.
备注
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¶
- 类型:
str- 默认:
'convert'on Unix;'magick'on Windows
A path to a conversion command. By default, the imgconverter finds the command from search paths.
在 3.1 版本发生变更: Use magick command by default on windows
- image_converter_args¶
- 类型:
Sequence[str]- 默认:
['convert']on Windows;()on Unix
Additional command-line arguments to give to convert, as a list.
在 3.1 版本发生变更: Use
['convert']by default on Windows