{"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":[{"note":"Direct import of the extension's module is never needed; you add to extensions list.","symbol":"sphinxcontrib.images","correct":"from sphinxcontrib.images import ImageThumbnail"}],"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,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Ensure 'sphinxcontrib.images' is in the extensions list.","cause":"Extension not enabled in conf.py, or extension name typo.","error":"WARNING: unknown directive type 'image-thumbnail'."},{"fix":"Run `pip install sphinxcontrib-images` and verify with `pip list | grep sphinxcontrib`.","cause":"Package not installed or installed in wrong environment.","error":"ModuleNotFoundError: No module named 'sphinxcontrib'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}