Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Sphinx "images" extension

Project Description

sphinxcontrib-images (formerly sphinxcontrib-fancybox).

Easy sphinx thumbnails (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/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.

Release History

Release History

This version
History Node

0.7.0

History Node

0.6.0

History Node

0.5.0

History Node

0.4.3

History Node

0.4.2

History Node

0.4.1

History Node

0.4.0

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
sphinxcontrib_images-0.7.0-py2-none-any.whl (65.4 kB) Copy SHA256 Checksum SHA256 2.7 Wheel Jan 12, 2016
sphinxcontrib_images-0.7.0-py3-none-any.whl (65.4 kB) Copy SHA256 Checksum SHA256 3.4 Wheel Jan 12, 2016
sphinxcontrib-images-0.7.0.tar.gz (61.4 kB) Copy SHA256 Checksum SHA256 Source Jan 12, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting