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 Distribution
Hashes for sphinxcontrib-images-0.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e843ee52bb370d3b1e09ca68634f6cfd095373f42a7b5ae06bbefe9f32b1ae28 |
|
MD5 | 9b013051021fdf38597a01fa40a485ac |
|
BLAKE2b-256 | fa6cae9547b79c543926068acd0d5ef133cb8d52a6fe4409decc460e1e30c175 |
Hashes for sphinxcontrib_images-0.8.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 46e8ab17b458d87ca7d84914aa99a5eea2c2a4cd842fa7dd98fca95be51becaa |
|
MD5 | bfb1073d73175d10e55ec8282550b8dd |
|
BLAKE2b-256 | 1909da51642f401be838476d5f02fb6b382600f731cdbcbf0579d431f2be3378 |