sphinxcontrib-images
Sphinx extension for thumbnails
Decision gist · record as of 2026-08-14
Yes, if you are building HTML documentation with Sphinx and want thumbnail and lightbox functionality without heavy setup. The low install friction and permissive license make it a reasonable choice. However, be aware that the project is aging (433 days since last release) and core features like actual image scaling are still TODO; verify that the current state meets your needs before committing to it in production documentation pipelines.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Requires Python 3.9 or later; thumbnail generation (image scaling) is listed as a TODO and not yet implemented.
- Low friction install with only requests and sphinx as runtime dependencies.
- Maintenance status is aging—last release was 433 days ago, though the repository remains active with a recent commit on 2025-07-29.
License · maintenance · safety
Apache-2.0 (permissive) — Licensed under Apache-2.0 (permissive), allowing use in commercial and open-source projects with minimal restrictions.
last release 2025-06-07 (433 days) · last repo commit 2025-07-29 · 23 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 86,583 downloads/mo, #13,850 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-images
Then add to conf.py:
extensions = ['sphinxcontrib.images']
In your .rst file:
.. thumbnail:: picture.png- Whether remote image caching actually works or is still in development
- Current state of non-HTML output support (latex, epub fallback behavior)
- Whether LightBox2 integration is fully functional or has known limitations
- How actively the extension is maintained given 433 days since last release
What it is and what it does
sphinxcontrib-images is a Sphinx extension that enhances HTML documentation by replacing standard image directives with thumbnail previews and lightbox zoom functionality. It lets you display smaller preview images in your docs that expand when clicked, improving page load time and visual organization. The extension depends on Sphinx and requests, and works by intercepting the image directive during documentation builds.
The package supports grouping images, downloading and caching remote images, and provides fallback rendering for non-HTML formats like LaTeX and EPUB. It is designed to be extensible—you can add custom HTML preview solutions or preprocess images by writing a few lines of code. However, the TODO list notes that proper image scaling (thumbnail generation) is not yet implemented, so it currently shows full-size images in a thumbnail container rather than creating actual scaled versions.
Use it for
- Reduce HTML documentation page load time by showing image thumbnails instead of full-resolution images
- Add interactive lightbox zoom to image galleries in Sphinx-generated documentation
- Group related images in documentation with automatic preview and enlargement on click
- Cache remote images locally during documentation builds to avoid external dependencies
- Extend the extension with custom preview backends or image preprocessing pipelines
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are building HTML documentation with Sphinx and want thumbnail and lightbox functionality without heavy setup.
The low install friction and permissive license make it a reasonable choice. However, be aware that the project is aging (433 days since last release) and core features like actual image scaling are still TODO; verify that the current state meets your needs before committing to it in production documentation pipelines.
Install
sphinxcontrib-images on PyPI
Before you install
Low friction install with only requests and sphinx as runtime dependencies. Maintenance status is aging—last release was 433 days ago, though the repository remains active with a recent commit on 2025-07-29.
Requires Python 3.9 or later; thumbnail generation (image scaling) is listed as a TODO and not yet implemented.
License in practice
Licensed under Apache-2.0 (permissive), allowing use in commercial and open-source projects with minimal restrictions.
Quickstart
pip install sphinxcontrib-images
Then add to conf.py:
extensions = ['sphinxcontrib.images']
In your .rst file:
.. thumbnail:: picture.pngVerify before relying
- Whether remote image caching actually works or is still in development
- Current state of non-HTML output support (latex, epub fallback behavior)
- Whether LightBox2 integration is fully functional or has known limitations
- How actively the extension is maintained given 433 days since last release
Package facts
| License | Apache-2.0 permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagesrequestssphinx |
| Maintenance | Aging 433 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 86,583 / month, #13,850 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 4 - BetaEnvironment :: ConsoleEnvironment :: Web EnvironmentIntended Audience :: DevelopersOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.9Topic :: Documentation |
Evidence: sphinxcontrib_images-1.0.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx thumbnail extension”
- sphinxcontrib-imagesA Sphinx extension that replaces standard image directives with…
- sphinxcontrib-jqueryA Sphinx extension that ensures jQuery is available for use by Sphinx…
- sphinxcontrib-htmlhelpA Sphinx extension that generates HTML help files from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also sphinxcontrib-openapi · sphinx-panels · sphinxcontrib-video · sphinx-substitution-extensions · sphinxcontrib-youtube · sphinx_mdinclude · sphinx-hoverxref · sphinxcontrib-typer · sphinxext-opengraph · easy-thumbnails