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.4.0.tar.gz (9.1 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.4.0-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: sphinx_thumb_image-0.4.0.tar.gz
  • Upload date:
  • Size: 9.1 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.4.0.tar.gz
Algorithm Hash digest
SHA256 eb9137c1b766bd90101196f692cb867a41faa5c04d78ee7f5e57bf2e6b731de2
MD5 77f4dbccf74422515168df6482af2029
BLAKE2b-256 c4bffebb0a48572b11547eb0508cfb0f3c5259c6e8c8808b42e3fbd769eb9010

See more details on using hashes here.

Provenance

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

File metadata

File hashes

Hashes for sphinx_thumb_image-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 324933f12c144314ac701989ccbb97a66d2e234da74aa403eb686ae393c3ba97
MD5 eff46828ffe72757875b2da0d2603068
BLAKE2b-256 f119b8ef5140b40555207eead9b32e65ca1cbb1a7dc0de2327a54a11da46d64a

See more details on using hashes here.

Provenance

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