ScyllaDB Docs ScyllaDB Sphinx Theme Examples Images

For AI agents: a documentation index is available at https://sphinx-theme.scylladb.com/master/llms.txt. A Markdown version of this page is at https://sphinx-theme.scylladb.com/master/examples/images.md.

Caution

You're viewing documentation for an unstable version of ScyllaDB Sphinx Theme. Switch to the latest stable version.

Images¶

There are two possible directives for images: the image directive and the figure directive. Refer to DocUtils for more options.

Image directive¶

.. image:: images/checkmark.png
    :alt: checkmark

Renders the image:

Figure directive¶

The figure directive allows you to use captions.

.. figure:: images/checkmark.png
   :alt: checkmark

   This is the caption for the image

Renders the image as:

Resize images¶

You can resize images (and figures) with the option width. When a reader clicks on an image with this option set, the image opens in a popup in full size. This is handy when images are too small to be read from the documentation page.

For example:

.. figure:: images/diagram.svg
   :width: 150px

.. image:: images/checkmark.png
   :width: 150px

Renders the image as:

Click on the image to preview it in full size.

Diagrams with metadata¶

Use the diagram directive to wrap a figure or image with metadata so external tools can filter and extract diagrams. The :id: option becomes the wrapper’s HTML id attribute. The remaining options are exposed as data-* attributes on the wrapping <div class="diagram">.

.. diagram::
   :id: auth-flow
   :tags: networking, security
   :categories: security
   :deployment: core
   :last-reviewed: 2026-06-01

   .. figure:: images/diagram.svg
      :alt: Authentication flow

      Authentication flow diagram.

Renders as:

Was this page helpful?