{"id":24630,"library":"sphinxcontrib-images","title":"sphinxcontrib-images","description":"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.","status":"active","version":"1.0.1","language":"python","source_language":"en","source_url":"https://github.com/sphinx-contrib/images","tags":["sphinx","extension","images","thumbnails"],"install":[{"cmd":"pip install sphinxcontrib-images","lang":"bash","label":"Install from PyPI"}],"dependencies":[{"reason":"Required core dependency; extension is a Sphinx plugin.","package":"sphinx","optional":false}],"imports":[{"wrong":"from sphinxcontrib.images import ImageThumbnail","symbol":"LightBox2","correct":"from sphinxcontrib_images_lightbox2 import LightBox2"},{"wrong":"from sphinxcontrib.images import ImageThumbnail","symbol":"lightbox2","correct":"from sphinxcontrib_images_lightbox2 import lightbox2"}],"quickstart":{"code":"# conf.py\nextensions = ['sphinxcontrib.images']\n\n# In any .rst file:\n# .. image-thumbnail:: path/to/image.png\n#    :width: 200px","lang":"python","description":"Add the extension to your Sphinx conf.py, then use the directive in reStructuredText."},"warnings":[{"fix":"Use `if builder.name == 'html':` conditional in conf.py to include only for HTML builds.","message":"The extension only works with the HTML builder. Other builders (LaTeX, epub) will ignore or raise errors.","severity":"gotcha","affected_versions":"all"},{"fix":"Use raw `.. image::` if you need alignment or classes.","message":"The directive does not support Sphinx's image options like `:align:` or `:class:`. Those are silently ignored.","severity":"gotcha","affected_versions":"all"},{"fix":"Upgrade Python to 3.9+ and Sphinx to 6.0+, or pin to sphinxcontrib-images==0.8.6.","message":"Version 1.0.0 dropped support for Python <3.9 and Sphinx <6.0. Older setups will fail with import errors.","severity":"breaking","affected_versions":"<1.0.0"}],"env_vars":null,"search_vec":"'-11':30 '-14':31 '1.0.1':27 '2024':29 '3.9':41 '6.0':44 'add':8 'contrib':37 'current':25 'direct':13 'embed':15 'extens':6,46 'full':22 'full-siz':21 'imag':3,11,17,47 'image-thumbnail':10 'link':19 'maintain':32 'python':40 'releas':28 'requir':39 'size':23 'sphinx':5,36,43,45 'sphinx-contrib':35 'sphinxcontrib':2 'sphinxcontrib-imag':1 'thumbnail':12,16,48 'umbrella':38 'version':24,26","created_at":"2026-05-01T08:14:06.206723+00:00","updated_at":"2026-05-01T08:14:06.206723+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":"1.0.1","cli_name":"","cli_version":null,"type":"library","homepage":null,"github":"https://github.com/sphinx-contrib/images","docs":"https://sphinxcontrib-images.readthedocs.io/","changelog":null,"pypi":"https://pypi.org/project/sphinxcontrib-images/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["web-framework","serialization"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-08-02","install_tag":null}}