mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2026-11-02 09:00:00 -06:00
56 lines
1.7 KiB
ReStructuredText
56 lines
1.7 KiB
ReStructuredText
.. _sphinx.ext.imgconverter:
|
|
|
|
:mod:`sphinx.ext.imgconverter` -- A reference image converter using Imagemagick
|
|
===============================================================================
|
|
|
|
.. module:: sphinx.ext.imgconverter
|
|
:synopsis: Convert images to appropriate format for builders
|
|
|
|
.. versionadded:: 1.6
|
|
|
|
.. role:: code-py(code)
|
|
:language: Python
|
|
|
|
This extension converts images in your document to appropriate format for
|
|
builders. For example, it allows you to use SVG images with LaTeX builder.
|
|
As a result, you don't mind what image format the builder supports.
|
|
|
|
By default the extension uses ImageMagick_ to perform conversions,
|
|
and will not work if ImageMagick is not installed.
|
|
|
|
.. _ImageMagick: https://www.imagemagick.org
|
|
|
|
.. note::
|
|
|
|
ImageMagick rasterizes a SVG image on conversion. As a result, the image
|
|
becomes not scalable. To avoid that, please use other image converters like
|
|
`sphinxcontrib-svg2pdfconverter`__ (which uses Inkscape or
|
|
``rsvg-convert``).
|
|
|
|
.. __: https://github.com/missinglinkelectronics/sphinxcontrib-svg2pdfconverter
|
|
|
|
|
|
Configuration
|
|
-------------
|
|
|
|
.. confval:: image_converter
|
|
:type: :code-py:`str`
|
|
:default: :code-py:`'convert'` on Unix; :code-py:`'magick'` on Windows
|
|
|
|
A path to a conversion command. By default, the imgconverter finds
|
|
the command from search paths.
|
|
|
|
.. versionchanged:: 3.1
|
|
|
|
Use :command:`magick` command by default on windows
|
|
|
|
.. confval:: image_converter_args
|
|
:type: :code-py:`Sequence[str]`
|
|
:default: :code-py:`['convert']` on Windows; :code-py:`()` on Unix
|
|
|
|
Additional command-line arguments to give to :command:`convert`, as a list.
|
|
|
|
.. versionchanged:: 3.1
|
|
|
|
Use ``['convert']`` by default on Windows
|