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

在 1.6 版本加入.

此插件将文档中的图像转换为适合生成器的格式。例如,它允许您在LaTexBuilder中使用SVG图像。因此,您不介意构建器支持什么图像格式。

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

备注

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

配置

image_converter
类型:
str
默认:
'convert' on Unix; 'magick' on Windows

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

在 3.1 版本发生变更: 在windows上默认使用 magick 命令

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

以列表形式,向 convert 提供的其他命令行参数。

在 3.1 版本发生变更: 默认在Windows上使用 ['convert']