Sphinx Thumb Image

Resize images in Sphinx documents/pages to thumbnails.

The purpose of this extension is to save on web storage costs and bandwidth fees, including data rates your visitors may incur from image-heavy documentation. If the fullsize image is not referenced by another image directive it won’t be copied into your build’s output directory.

sphinx-thumb-image provides a thumb-image directive similar to the built in image directive. Set the thumbnail size using the :resize-width: and/or :resize-height: options.

A list-table-thumbs directive is also provided to help reduce repetition when a lot of thumbnails are nested within a list-table. See the list-table-thumbs usage document for more information.

Project Links

• Documentation: https://sphinx-thumb-image.readthedocs.io

• Source code: https://github.com/Robpol86/sphinx-thumb-image

• PyPI homepage: https://pypi.org/project/sphinx-thumb-image

Contents

• Installation
• Usage
  • Images
  • Figures
  • List Table Thumbs
  • Configuration
• Examples
  • JPEG
  • PNG
  • Animated PNG (APNG)
  • Static GIF
  • Animated GIF
  • List Table Thumbs