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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0d5d720b69789c83bf1e6925093b32ab4cd6f925d24ecded56109fc0d0eb174 |
|
MD5 | 62f7c1506349ec12f37765b2a1411466 |
|
BLAKE2b-256 | 95a84af7f2ff3e4d03ab7c21c52ae3e84196683ed8f51c91a7100882cde21c4e |
Hashes for sphinxcontrib_images-0.9.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | db8d1b9cec0b71ba59ce1919d199a7d121bb7b916e96fb883c4f97b3f6bc6241 |
|
MD5 | 068d33bb371cceba64b8c45939c50825 |
|
BLAKE2b-256 | 7b4b81853c279f7e8345c5cf32c0c04b693ba4f37d6d217745aaf7347a1d08cc |