Images#

Images can be a great supplement to technical documentation text. Sphinx provides control for their alignment in the content, as well as the ability to add captions.

Basic Usage#

.. image:: https://source.unsplash.com/200x200/daily?cute+animals

This is from reStructuredText.
https://source.unsplash.com/200x200/daily?cute+animals

This is from reStructuredText.

![](https://source.unsplash.com/200x200/daily?cute+animals)

This is from Markdown.

This is from Markdown.

Alignment#

.. image:: https://source.unsplash.com/200x200/daily?cute+animals
   :align: center


This is from reStructuredText.
https://source.unsplash.com/200x200/daily?cute+animals

This is from reStructuredText.

```{image} https://source.unsplash.com/200x200/daily?cute+animals
:align: center
```

This is from Markdown.
https://source.unsplash.com/200x200/daily?cute+animals

This is from Markdown.

Captions#

.. figure:: https://source.unsplash.com/200x200/daily?cute+animals

    This is a captioned image, which needs the "figure" directive.

This is from reStructuredText.
https://source.unsplash.com/200x200/daily?cute+animals

This is a captioned image, which needs the “figure” directive.#

This is from reStructuredText.

```{figure} https://source.unsplash.com/200x200/daily?cute+animals
This is a captioned image, which needs the "figure" directive.
```

This is from Markdown.
https://source.unsplash.com/200x200/daily?cute+animals

This is a captioned image, which needs the “figure” directive.#

This is from Markdown.

Last updated on Jan 16, 2024.