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

版本 1.6 中新增。

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

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

注意

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

配置

image_converter

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

在 Unix 平台上,默认情况下使用 convert 命令。

在 Windows 上,默认情况下使用 magick 命令。

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

image_converter_args

传递给 convert 的其他命令行参数,以列表形式给出。默认值为一个空列表 []

在 Windows 上,默认为 ["convert"]

版本 3.1 中已更改: 在 Windows 上默认为 ["convert"]