sphinx.ext.imgconverter – 一个使用 Imagemagick 的参考图像转换器

版本 1.6 中新增。

此扩展将文档中的图像转换为适合构建器的格式。例如,它允许您将 SVG 图像与 LaTeX 构建器一起使用。因此,您无需关心构建器支持何种图像格式。

默认情况下,此扩展使用 ImageMagick 执行转换,如果未安装 ImageMagick 则无法工作。

注意

ImageMagick 在转换时会将 SVG 图像栅格化。因此,图像变得不可缩放。为避免这种情况,请使用其他图像转换器,如 sphinxcontrib-svg2pdfconverter (它使用 Inkscape 或 rsvg-convert)。

配置

image_converter
类型:
str
默认:
在 Unix 上为 'convert';在 Windows 上为 'magick'

转换命令的路径。默认情况下,imgconverter 从搜索路径中查找命令。

3.1 版中已更改: 在 Windows 上默认使用 magick 命令

image_converter_args
类型:
序列[str]
默认:
在 Windows 上为 ['convert'];在 Unix 上为 ()

要提供给 convert 的额外命令行参数,以列表形式。

3.1 版中已更改: 在 Windows 上默认使用 ['convert']