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"]を使用するようになりました