sphinxcontrib-images

sphinxcontrib-images (formerly sphinxcontrib-fancybox).

Easy thumbnails in Sphinx documentation (focused on HTML).

Features

Show thumbnails instead of full size images inside documentation (HTML).
Ability to zoom/enlarge picture using LightBox2 (HTML).
Ability to group pictures
Download remote pictures and keep it in cache (if requested)
Support for other formats (latex, epub, … - fallback to image directive)
Easy to extend (add own backend in only few lines of code)
- Add other HTML “preview” solution than LightBox2
- Add better support to non-HTML outputs
- Preprocess images

Instalation through pip:

pip install sphinxcontrib-images

or through the GitHub:

pip install git+https://github.com/sphinx-contrib/images

Next, you have to add extension to conf.py in your Sphinx project.

extensions = [
          …
          'sphinxcontrib.images',
          …
          ]

Example:

.. thumbnail:: picture.png

You can also override the default image directive provided by Sphinx. Check the documentation for all configuration options.

If you have any suggstions, patches, problems - please use GitHub Issues.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Table of built distributions (wheels) for sphinxcontrib-images 1.0.1
File	Interpreter	ABI	Platform	Reset
sphinxcontrib_images-1.0.1-py3-none-any.whl 119.7 kB Jun 7, 2025	Python 3	none	any	Details

Download URL	sphinxcontrib_images-1.0.1-py3-none-any.whl
Size	119.7 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3cc9738dc15bacb3ab153b411a1b50dbfaa2535b49853ef3eae4d22adbbffa26`
BLAKE2b-256 checksum How to use checksums	`08c5402cce1cc18caff306effa09e77fdb3872289edc956a5c1bf53c03799b3b`
Upload date	Jun 7, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.12.10`