sphinx.transforms.post_transforms.images.ImageConverter

class documentation

class ImageConverter(BaseImageConverter):

Known subclasses: sphinx.ext.imgconverter.ImagemagickConverter

A base class for image converters.

An image converter is kind of Docutils transform module. It is used to convert image files which are not supported by a builder to the appropriate format for that builder.

For example, LaTeX builder supports PDF, PNG and JPEG as image formats. However it does not support SVG images. For such case, using image converters allows to embed these unsupported images into the document. One of the image converters; :ref:`sphinx.ext.imgconverter <sphinx.ext.imgconverter>` can convert a SVG image to PNG format using Imagemagick internally.

There are three steps to make your custom image converter:

Make a subclass of ImageConverter class
Override conversion_rules, is_available() and convert()
Register your image converter to Sphinx using .Sphinx.add_post_transform

Method	`convert`	Convert an image file to the expected format.
Method	`is_available`	Return the image converter is available or not.
Class Variable	`available`	Undocumented
Class Variable	`conversion_rules`	Undocumented
Method	`__init__`	Undocumented
Method	`get_conversion_rule`	Undocumented
Method	`guess_mimetypes`	Undocumented
Method	`handle`	Undocumented
Method	`match`	Undocumented
Class Variable	`default_priority`	Undocumented

Inherited from BaseImageConverter:

Method	`apply`	Undocumented
Property	`imagedir`	Undocumented

Inherited from SphinxTransform (via BaseImageConverter):

Property	`app`	Reference to the `.Sphinx` object.
Property	`config`	Reference to the `.Config` object.
Property	`env`	Reference to the `.BuildEnvironment` object.

def convert(self, _from, _to):

overridden in sphinx.ext.imgconverter.ImagemagickConverter

Convert an image file to the expected format.

_from is a path of the source image file, and _to is a path of the destination file.

Parameters
_from:`str`	Undocumented
_to:`str`	Undocumented
Returns
`bool`	Undocumented

def is_available(self):

overridden in sphinx.ext.imgconverter.ImagemagickConverter

Return the image converter is available or not.

Returns
`bool`	Undocumented

available: Optional[bool] =

Undocumented

conversion_rules: List[Tuple[str, str]] =

overridden in sphinx.ext.imgconverter.ImagemagickConverter

Undocumented

def __init__(self, *args, **kwargs):

Undocumented

Parameters
*args:`Any`	Undocumented
**kwargs:`Any`	Undocumented

def get_conversion_rule(self, node):

Undocumented

Parameters
node:`nodes.image`	Undocumented
Returns
`Tuple[str, str]`	Undocumented

def guess_mimetypes(self, node):

Undocumented

Parameters
node:`nodes.image`	Undocumented
Returns
`List[str]`	Undocumented

def handle(self, node):

overrides sphinx.transforms.post_transforms.images.BaseImageConverter.handle

Undocumented

Parameters
node:`nodes.image`	Undocumented

def match(self, node):

overrides sphinx.transforms.post_transforms.images.BaseImageConverter.match

Undocumented

Parameters
node:`nodes.image`	Undocumented
Returns
`bool`	Undocumented

default_priority: int =

Undocumented