Skip to main content

Sphinx extension that resizes images into thumbnails on the fly

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.1.0.tar.gz (8.0 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.1.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_thumb_image-0.1.0.tar.gz
  • Upload date:
  • Size: 8.0 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.1.0.tar.gz
Algorithm Hash digest
SHA256 d96ca62d637e6e27e1fe61421960078d30687797d1bc56e4a150d93ee30a5de5
MD5 b1c4d0e2ece9efff979b28b9244709b9
BLAKE2b-256 ed3c75dc4bf9cfba84baf32ab582de9f4944acf3ac86a656f426f4725f23296a

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_thumb_image-0.1.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.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_thumb_image-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e967469a30bcf88e30f590c6b928c4686180baab6313525acb1252fa0656ea3
MD5 a31eb26d32b2dad67e92868e58767330
BLAKE2b-256 f2e704e23db1cd9d98e38d32639f720c798fac1b9cc0393b3fd39cb55e0ebd9f

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_thumb_image-0.1.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