Skip to main content

Resize images in Sphinx documents/pages to thumbnails

Project description

sphinx-thumb-image

Resize images in Sphinx documents/pages to thumbnails.

The purpose of this extension is to save on web storage costs and bandwidth fees, including data rates your visitors may incur from image-heavy documentation. If the fullsize image is not referenced by another image directive it won't be copied into your build's output directory.

  • Python 3.9 through 3.14 supported on Linux, macOS, and Windows.

📖 Full documentation: https://sphinx-thumb-image.readthedocs.io

Github-CI Coverage Status Documentation Status PyPI PyPI Downloads

Quickstart

To install run the following:

pip install sphinx-thumb-image

To use in Sphinx simply add to your conf.py:

extensions = ["sphinx_thumb_image"]

And in your Sphinx documents:

.. thumb-image:: pictures/photo.jpg
    :resize-width: 100px

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_thumb_image-0.3.0.tar.gz (8.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_thumb_image-0.3.0-py3-none-any.whl (8.8 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_thumb_image-0.3.0.tar.gz.

File metadata

  • Download URL: sphinx_thumb_image-0.3.0.tar.gz
  • Upload date:
  • Size: 8.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for sphinx_thumb_image-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d536e0709dd1ae2275c4ca9f810f87585cd150504787eaa4de3fc3046179e7c7
MD5 4788a8f02ad3a69ef47defb4a19e1cbf
BLAKE2b-256 8ad018a559e649529aae6f60d47baffcaef2ac644a7f5aa1a94fe5b56151d876

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_thumb_image-0.3.0.tar.gz:

Publisher: pypi.yml on Robpol86/sphinx-thumb-image

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sphinx_thumb_image-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_thumb_image-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fcc1f28435e28f1887d81651da973e629b71facdcbcc26e88fe0ebcf01f37640
MD5 d21ce57e90ae660e604aadbc8c6fde3e
BLAKE2b-256 dcabb034f671fa283586f3ef8b13fe0bd0a95cb99631af7ebdbfa5cfc2726078

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_thumb_image-0.3.0-py3-none-any.whl:

Publisher: pypi.yml on Robpol86/sphinx-thumb-image

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page