Sphinx "images" extension
Project description
sphinxcontrib-images (formerly sphinxcontrib-fancybox).
PyPI.
TravisCI
Features
Show thumbnails instead of full size images inside documentation.
Ability to zoom/enlarge picture using LightBox2 (or any other backend)
Ability to group pictures
Download remote pictures (if requested)
TODO
Make proper thumbnails (scale down images)
Make support for other formats (latex, epub, etc)
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.4.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4f163b6af24534b414422b0a4fa57341088e140337d45c2aa49657c6d82075fe |
|
MD5 | cd05c1e26e6680269ee26f88aba3a0e4 |
|
BLAKE2b-256 | 27c5b25cf66a3ac6c38f496fb21316fd183e4cb493c7a39838d523514c3ce55b |
Hashes for sphinxcontrib_images-0.4.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3ef02bd394062f8baac6d6dc28937b34cb0822700fe05e4d8dd3f2ba9ba8fe25 |
|
MD5 | 4d363f03b90849c9592a8e0ca3757c64 |
|
BLAKE2b-256 | 2064adac189c8bce37e9861bebb2bbcdcd6f2162e657b6863cfb46858c93c20f |
Hashes for sphinxcontrib_images-0.4.3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f08dc2d665f82996d36a54ff588c2f9d47ac69764be3a113bea6ee34cf118df |
|
MD5 | a490c8c9c4d425e755baf35f8419df7a |
|
BLAKE2b-256 | 69301b8ff58f6827ca302f325fc8a2de6c6bcacd637c57f96ac29fc5eced4b21 |