sphinx.util.images

module documentation

Image utility functions for Sphinx.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Variable ​Image Undocumented
Variable mime​_suffixes Undocumented
Class ​Data​URI Undocumented
Function get​_image​_extension Undocumented
Function get​_image​_size Undocumented
Function guess​_mimetype Undocumented
Function guess​_mimetype​_for​_stream Undocumented
Function parse​_data​_uri Undocumented
Function test​_svg An additional imghdr library helper; test the header is SVG's or not.
Image =

Undocumented

mime_suffixes =

Undocumented

def get_image_extension(mimetype):

Undocumented

Parameters
mimetype:strUndocumented
Returns
Optional[str]Undocumented
def get_image_size(filename):

Undocumented

Parameters
filename:strUndocumented
Returns
Optional[Tuple[int, int]]Undocumented
def guess_mimetype(filename='', default=None):

Undocumented

Parameters
filename:strUndocumented
default:Optional[str]Undocumented
Returns
Optional[str]Undocumented
def guess_mimetype_for_stream(stream, default=None):

Undocumented

Parameters
stream:IOUndocumented
default:Optional[str]Undocumented
Returns
Optional[str]Undocumented
def parse_data_uri(uri):

Undocumented

Parameters
uri:strUndocumented
Returns
Optional[DataURI]Undocumented
def test_svg(h, f):
An additional imghdr library helper; test the header is SVG's or not.
Parameters
h:bytesUndocumented
f:Optional[BinaryIO]Undocumented
Returns
Optional[str]Undocumented