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.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6db467ddb15c1c2367cd94ecc16147c91509979fa2fca4890b61d30532ec3333 |
|
MD5 | 3027ce6c0cc0a61a2d37d8154ca5f9bb |
|
BLAKE2b-256 | 34901a4c8488ce1a1b61993bd20bd1e1ef79362c7c49f7833a50e982c35bd4de |
Hashes for sphinxcontrib_images-0.9.3-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2a70f13242aa937ce3600cc238d145d3f5ba1db00cb40ee93e67201773a8dd2 |
|
MD5 | 580e886c97715c710cbbff22262d34f4 |
|
BLAKE2b-256 | b1723478c35d92a08f6c68b444aba16f2e45edf53bb21bc2901de509bad34a2a |