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
類型:
序列[str]
預設:
['convert'] (在 Windows 上); () (在 Unix 上)

要傳遞給 convert 的其他命令列引數,以列表形式呈現。

在版本 3.1 中變更:預設在 Windows 上使用 ['convert']