Sphinx "images" extension
Project description
sphinxcontrib-images (formerly sphinxcontrib-fancybox).
Easy sphinx thumbnails (focused on HTML).
PyPI.
TravisCI <https://travis-ci.org/spinus/sphinxcontrib-images>
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/spinus/sphinxcontrib-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 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 Distributions
Hashes for sphinxcontrib-images-0.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c605b538494394ce7f9e594e9c20f3e4ccb869f62073c65f4d9c734d1a84d1c4 |
|
MD5 | 3fb153acd45ade10c8f124fdd8b2d97d |
|
BLAKE2b-256 | bbab5b6379b5acd3c5ce289f7e725a9b1c48d54d712b649d09363d91d364c23d |
Hashes for sphinxcontrib_images-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d39d237cecae5a9d62779e558389440653f999ac9f936256ec9b0b1a8f61ad0f |
|
MD5 | 20b85b3233981a3de4dcef6568a0d15a |
|
BLAKE2b-256 | d65fda4f978faa953ba129b16a6885eabaefdc001a4de784f312e0099bb60b2b |
Hashes for sphinxcontrib_images-0.6.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ab7e7de4c9063f087eafa01d8809133edeabffaa12bc98db949a0a6833e2f915 |
|
MD5 | db6fb510bc0b073b647053ea28dee52b |
|
BLAKE2b-256 | fd62b19bae0199a6ccf034a1d930d4ab2d08f468c7298050606a74b406ea2f5e |