sphinx.ext.imgconverter.ImagemagickConverter

class documentation

class ImagemagickConverter(ImageConverter): (source)

View In Hierarchy

Undocumented

Method convert Converts the image to expected one.
Method is_available Confirms the converter is available or not.
Class Variable conversion_rules Undocumented

Inherited from ImageConverter:

Method __init__ Undocumented
Method get_conversion_rule Undocumented
Method guess_mimetypes Undocumented
Method handle Undocumented
Method match Undocumented
Class Variable available Undocumented
Class Variable default_priority Undocumented

Inherited from BaseImageConverter (via ImageConverter):

Method apply Undocumented
Property imagedir Undocumented

Inherited from SphinxTransform (via ImageConverter, BaseImageConverter):

Property app Reference to the :class:`.Sphinx` object.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def convert(self, _from, _to): (source)
overrides sphinx.transforms.post_transforms.images.ImageConverter.convert

Converts the image to expected one.

Parameters
_from:strUndocumented
_to:strUndocumented
Returns
boolUndocumented
def is_available(self): (source)
overrides sphinx.transforms.post_transforms.images.ImageConverter.is_available

Confirms the converter is available or not.

Returns
boolUndocumented
conversion_rules: list = (source)
overrides sphinx.transforms.post_transforms.images.ImageConverter.conversion_rules

Undocumented