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.2.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.2.0-py3-none-any.whl (8.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_thumb_image-0.2.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.2.0.tar.gz
Algorithm Hash digest
SHA256 a60e1234c1d6043ee675759d1939683ca9484ed5c25ddaff3855aabac57df3e3
MD5 f69813f3af300a5f1ac6e2f9b0494bbb
BLAKE2b-256 ac464d30aa1f3106a8c34e76a517cf926c718b81622591086dc9e7b25fd7f4c1

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_thumb_image-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1d7b091db6ed319beccdb0ad2b6b2cd21c37c7d861e14354881f1e052ebf6849
MD5 cc71aa9e81ec7e24e5b3cc13a19196f7
BLAKE2b-256 cf556767f71483f0006cb4ffa3a6a35c1ed238d7907f189869c594d0ed83f9ad

See more details on using hashes here.

Provenance

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