Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

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.

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_images-0.7.0-py2-none-any.whl (65.4 kB) Copy SHA256 hash SHA256 Wheel 2.7 Jan 12, 2016
sphinxcontrib_images-0.7.0-py3-none-any.whl (65.4 kB) Copy SHA256 hash SHA256 Wheel 3.4 Jan 12, 2016
sphinxcontrib-images-0.7.0.tar.gz (61.4 kB) Copy SHA256 hash SHA256 Source None Jan 12, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page