sphinx.ext.imgconverter
--使用ImageMagick的参考图像转换器¶
Added in version 1.6.
此扩展名将文档中的图像转换为生成器所需的适当格式。例如,它允许您在LaTex Builder中使用SVG图像。因此,您不介意构建器支持什么图像格式。
默认情况下,扩展使用 ImageMagick 执行转换,如果未安装ImageMagick,则不起作用。
备注
ImageMagick在转换时栅格化SVG图像。结果,图像变得不可缩放。为了避免这种情况,请使用其他图像转换器,如 sphinxcontrib-svg2pdfconverter (使用Inkscape或 rsvg-convert
)。
配置¶
- image_converter¶
转换命令的路径。默认情况下,imgConverter从搜索路径中查找命令。
在Unix平台上,命令 convert 默认情况下使用。
在Windows上,命令 magick 默认情况下使用。
在 3.1 版本发生变更: 使用 magick 在windows上默认使用命令
- image_converter_args¶
要提供给的其他命令行参数 convert 作为一个列表。默认为空列表
[]
.在Windows上,它默认为
["convert"]
。在 3.1 版本发生变更: 使用
["convert"]
Windows上的默认设置