image¶

image related directives.

class rstobj.directives.image.Image(class_: Optional[str] = None, name: Optional[str] = None, uri: Optional[str] = None, height: Optional[int] = None, width: Optional[int] = None, scale: Optional[int] = None, alt_text: Optional[str] = None, align: Optional[str] = None)[source]¶

The .. image:: directive.

parameter definition see here: http://docutils.sourceforge.net/docs/ref/rst/directives.html#image

Parameters

uri – required.
height – optional.
width – optional.
scale – optional.
alt_text – optional.
align – optional. one of Image.AlignOptions.

Example:

img = Image(
    uri="https://www.python.org/static/img/python-logo.png",
    height=320,
    width=320,
    alt_text="Image Not Found",
    align=Image.AlignOptions.center,
)
img.render()

Output:

.. image:: https://www.python.org/static/img/python-logo.png
    :height: 320px
    :width: 320px
    :alt: Image Not Found
    :align: center

class AlignOptions[source]¶

align argument choices.

Image.AlignOptions.left: "left"
Image.AlignOptions.center: "center"
Image.AlignOptions.right: "right"
Image.AlignOptions.top: "top"
Image.AlignOptions.middle: "middle"
Image.AlignOptions.bottom: "bottom"

property arg¶

Return type