sphinx.ext.imgconverter – 一个使用Imagemagick的参考图像转换器¶
Added in version 1.6.
该扩展将文档中的图像转换为构建器的适当格式. 例如,它允许您在 LaTeX 构建器中使用 SVG 图像. 结果是,您无需担心构建器支持哪个图像格式.
默认情况下,该扩展使用 ImageMagick 进行转换,如果未安装 ImageMagick,则无法工作.
备注
ImageMagick在转换时将SVG图像栅格化.因此,图像变得不可缩放.为了避免这种情况,请使用其他图像转换器,例如 sphinxcontrib-svg2pdfconverter`__（它使用Inkscape或 ``rsvg-convert` ）.
配置¶
- image_converter¶
转换命令的路径.默认情况下,imgconverter会从搜索路径中找到该命令.
在Unix平台上,默认使用命令 convert .
在Windows上,默认使用命令 magick .
在 3.1 版本发生变更: 在Windows上默认使用:command:magick 命令
- image_converter_args¶
要传递给 convert 的附加命令行参数,以列表形式提供.默认值是一个空列表
[].在Windows上,它默认为
["convert"].在 3.1 版本发生变更: 在Windows上默认使用
["convert"]