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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2643267ee54eb0a1e5ccfa720207f2444fc44ba99cd204bce87d31d02bab0e0b |
|
MD5 | bd0f970e4554755d601c05539f8498ac |
|
BLAKE2b-256 | 37456fafd6f3014f0443b643862a72c35aa58b63800a4a87d0c66423525884d9 |
Hashes for sphinxcontrib_images-0.9.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5098365ca4faf400a118b49ed5c35303522c328deec98e0ad1bf653308594829 |
|
MD5 | 37e02924349bca86d8a112856bff1a42 |
|
BLAKE2b-256 | 03ca97209ddc8fb508051a29c5760bf4aa03676874056f0d2588fb1277bf104e |