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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c2d84c0c3575a54638eb083d16614ad09c6fc68a02900f70ac05452e1d9955e |
|
MD5 | 4c4485beba8bb80b3ea020006770b236 |
|
BLAKE2b-256 | ae6dca8adf7ab9e9a5a921e0c643d05e83e9c3b21fd8ba294bdba191eb64c671 |
Hashes for sphinxcontrib_images-0.9.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 497a6d210e2bb1a13ffc79e3ac735b0087cf95fb597db1aca68a880d6e12a040 |
|
MD5 | 38abc2a2c359e70d636f6f4a02c5ca2a |
|
BLAKE2b-256 | dc00778158f28b616596b7f3d7a4027363fe789776ab98a4e544411706bb0096 |