ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs ScyllaDB Sphinx Theme Examples Images

Caution

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

Images¶

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

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

renders the image

checkmark

Whereas 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:

checkmark

This is the caption for the image¶

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:

../_images/diagram.svg
../_images/checkmark.png

Click on the image to preview it in full size.

Was this page helpful?

PREVIOUS
Includes
NEXT
Links
  • Create an issue
  • Edit this page

On this page

  • Images
    • Resize images
ScyllaDB Sphinx Theme
  • 1.2
    • 1.8
    • 1.7
    • 1.6
    • 1.5
    • 1.4
    • 1.3
    • 1.2
    • 1.1
  • Getting started
    • Toolchain
    • Installation
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirections support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.1 to 1.2
    • Migrating from 1.0 to 1.1
    • Migrating from 0.x to 1.0
    • Changelog
  • Contribute
    • Contribute to the documentation
    • Contribute to the theme
    • Source Code
Docs Tutorials University Contact Us About Us
© 2025 ScyllaDB | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 01 Apr 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6
Ask AI