Registry / web-framework / sphinxcontrib-images

sphinxcontrib-images

library1.0.1pypypi✓ verified 79d ago

A Sphinx extension that adds a `.. image-thumbnail::` directive for embedding thumbnail images that link to full-size versions. Current version 1.0.1 (released 2024-11-14), maintained under the sphinx-contrib umbrella. Requires Python >=3.9 and Sphinx >=6.0.

web-framework serialization

pip install sphinxcontrib-images

github ↗package ↗docs ↗

INSTALL

IMPORT

SIG · SPHINXCONTRIB-IMAG

sphinxcontrib-images

web-frameworkpythonv1.0.1

Install

5.4s avg

Import

—

Disk

94MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v1.0.1 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 92.2MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 5.4s · import 0.000s · 93MB

94MB installed

● package 94MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

LightBox2

✓ from sphinxcontrib_images_lightbox2 import LightBox2

✗ from sphinxcontrib.images import ImageThumbnail

lightbox2

✓ from sphinxcontrib_images_lightbox2 import lightbox2

✗ from sphinxcontrib.images import ImageThumbnail

Add the extension to your Sphinx conf.py, then use the directive in reStructuredText.

# conf.py extensions = ['sphinxcontrib.images'] # In any .rst file: # .. image-thumbnail:: path/to/image.png # :width: 200px

Debug

Known issues

gotchaThe extension only works with the HTML builder. Other builders (LaTeX, epub) will ignore or raise errors.

fix

Use `if builder.name == 'html':` conditional in conf.py to include only for HTML builds.

affects: all

gotchaThe directive does not support Sphinx's image options like `:align:` or `:class:`. Those are silently ignored.

fix

Use raw `.. image::` if you need alignment or classes.

affects: all

breakingVersion 1.0.0 dropped support for Python <3.9 and Sphinx <6.0. Older setups will fail with import errors.

fix

Upgrade Python to 3.9+ and Sphinx to 6.0+, or pin to sphinxcontrib-images==0.8.6.

affects: <1.0.0

Upgrade

Version history

1.0.1latest on PyPI · released Jun 7, 2025

Audit

Dependencies

sphinxrequiredRequired core dependency; extension is a Sphinx plugin.

Agent activity

5 hits · last 30 days

node

Resources

githubhttps://github.com/sphinx-contrib/images ↗

packagehttps://pypi.org/project/sphinxcontrib-images/ ↗

docshttps://sphinxcontrib-images.readthedocs.io/ ↗