Sphinx extension for thumbnails
Project description
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinxcontrib-images-0.9.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f6c237d0430793e65d91dbddb13b1fb26a2cf838040a9deeb52112969fbc4a4b |
|
MD5 | 2842c3609542b14976c6ceabb658d504 |
|
BLAKE2b-256 | 6352f0f6bcaa59231d8ac1efc8f6e92c9e14004bab2b420cefe3fcd60c082d0b |
Hashes for sphinxcontrib_images-0.9.4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8863e8e8533a116f45cb92523938ab25879cc31dc594f5de4c3dbd9ab3d440b0 |
|
MD5 | a9e19c1a7097eb338f2794d4adbb61b9 |
|
BLAKE2b-256 | 7163ca2260e431b94cf9fe073c12d363a4981b94483e08fb3962089047248540 |