sphinxcontrib-images (formerly sphinxcontrib-fancybox).
Easy thumbnails in Sphinx documentation (focused on HTML).
Features
Show thumbnails instead of full size images inside documentation (HTML).
Ability to zoom/enlarge picture using LightBox2 (HTML).
Ability to group pictures
Download remote pictures and keep it in cache (if requested)
Support for other formats (latex, epub, … - fallback to image directive)
Easy to extend (add own backend in only few lines of code)
Add other HTML “preview” solution than LightBox2
Add better support to non-HTML outputs
Preprocess images
TODO
Make proper thumbnails (scale down images)
How to install?
Instalation through pip:
pip install sphinxcontrib-images
or through the GitHub:
pip install git+https://github.com/sphinx-contrib/images
Next, you have to add extension to conf.py in your Sphinx project.
extensions = [
…
'sphinxcontrib.images',
…
]
How to use it?
Example:
.. thumbnail:: picture.png
You can also override the default image directive provided by Sphinx. Check the documentation for all configuration options.
Questions and suggestions
If you have any suggstions, patches, problems - please use GitHub Issues.
Release files for sphinxcontrib-images 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| sphinxcontrib_images-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for sphinxcontrib_images-1.0.1-py3-none-any.whl |
Release files / sphinxcontrib_images-1.0.1-py3-none-any.whl
| Download URL | sphinxcontrib_images-1.0.1-py3-none-any.whl |
|---|---|
| Size | 119.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3cc9738dc15bacb3ab153b411a1b50dbfaa2535b49853ef3eae4d22adbbffa26
|
|
BLAKE2b-256 checksum How to use checksums |
08c5402cce1cc18caff306effa09e77fdb3872289edc956a5c1bf53c03799b3b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.10
|
Security for sphinxcontrib-images 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
