ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
    • ScyllaDB Open Source
    • ScyllaDB Enterprise
    • ScyllaDB Alternator
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
Download
Menu
ScyllaDB Docs ScyllaDB Sphinx Theme Examples Images

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.

PREVIOUS
Includes
NEXT
Labels
ScyllaDB Sphinx Theme
  • 1.4
    • 1.4
    • 1.3
    • 1.2
    • 1.1
    • 1.0
  • Getting started
    • Toolchain
    • Installation
    • Quickstart
  • Configuration
    • Template options
    • Page options
    • Multiversion options
    • Markdown support
    • Redirects support
    • Search support
    • Troubleshooting
  • Commands
  • Deployment
    • Production deployment
    • Pull requests previews
  • Examples
    • Admonitions
    • Collapse
    • Code blocks
    • Glossary
    • Headings
    • Hero box
    • Includes
    • Images
    • Labels
    • Links
    • Lists
    • Panel box
    • Substitutions
    • Tables
    • Tabs
    • Text
    • TOC
    • Topic box
    • Versions
  • Upgrade guides
    • Migrating from 1.3 to 1.4
    • Migrating from 1.2 to 1.3
    • 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
  • Create an issue
  • Edit this page

On this page

  • Images
    • Resize images
Logo
Docs Contact Us About Us
Mail List Icon Slack Icon Forum Icon
© 2023, ScyllaDB. All rights reserved.
Last updated on 14 Mar 2023.
Powered by Sphinx 4.5.0 & ScyllaDB Theme 1.4.1