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.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 076d7d53d8e9ef19b09e57a10cc69ff19ec6a19641f707039d818741169d3434 |
|
MD5 | 40df7775f9a92198298965a5beec6ea5 |
|
BLAKE2b-256 | e3541d9057acbbb60c58359e7fa99ac2044201f284c7f7b78743a3097fa77e0f |
Hashes for sphinxcontrib_images-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 87ca0c261c61c302f6ceb261bfde3490b14b727b23e0d72e7e517bf05f0774a3 |
|
MD5 | 698b8bf3dc4e5acdba47170bed430426 |
|
BLAKE2b-256 | b25757de51d993dacc888f87f1d7131e51b7a427e4693227f911358f960f77c5 |
Hashes for sphinxcontrib_images-0.7.0-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5274822bc17520451193038380ac095b466dca61222889fd9af5c8e78c7b015b |
|
MD5 | 85dbdd0a1503982e2052983b73551c3f |
|
BLAKE2b-256 | 07473959ecf843fa30ae06346ff340bfd4e29ae4c46a0bac049bf0bd525d8b1a |