IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Improve sphinx.transforms.post_transforms.images docstrings

Browse Source
This commit is contained in:
Louis Maddox 2021-07-18 22:44:55 +01:00 committed by GitHub
parent 1c2e461e0d
commit 3e55a4634b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
sphinx/transforms/post_transforms/images.py
View File

@ -154,13 +154,13 @@ class ImageConverter(BaseImageConverter):
"""A base class for image converters. """A base class for image converters.
An image converter is kind of Docutils transform module. It is used to An image converter is kind of Docutils transform module. It is used to
convert image files which does not supported by builder to appropriate convert image files which are not supported by a builder to the
format for that builder. appropriate format for that builder.
For example, :py:class:`LaTeX builder <.LaTeXBuilder>` supports PDF, For example, :py:class:`LaTeX builder <.LaTeXBuilder>` supports PDF,
PNG and JPEG as image formats. However it does not support SVG images. PNG and JPEG as image formats. However it does not support SVG images.
For such case, to use image converters allows to embed these For such case, using image converters allows to embed these
unsupported images into the document. One of image converters; unsupported images into the document. One of the image converters;
:ref:`sphinx.ext.imgconverter <sphinx.ext.imgconverter>` can convert :ref:`sphinx.ext.imgconverter <sphinx.ext.imgconverter>` can convert
a SVG image to PNG format using Imagemagick internally. a SVG image to PNG format using Imagemagick internally.
@ -258,10 +258,10 @@ class ImageConverter(BaseImageConverter):
self.env.images.add_file(self.env.docname, destpath) self.env.images.add_file(self.env.docname, destpath)
def convert(self, _from: str, _to: str) -> bool: def convert(self, _from: str, _to: str) -> bool:
"""Convert a image file to expected format. """Convert an image file to the expected format.
*_from* is a path for source image file, and *_to* is a path for *_from* is a path of the source image file, and *_to* is a path
destination file. of the destination file.
""" """
raise NotImplementedError() raise NotImplementedError()