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

在 1.6 版本中添加。

此扩展程序将文档中的图像转换为适合构建器的格式。例如,它允许您将 SVG 图像与 LaTeX 构建器一起使用。因此,您不必在意构建器支持哪种图像格式。

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

注意

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

配置

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

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

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

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

要传递给 convert 的其他命令行参数,以列表形式。

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