Skip to main content

Sphinx extension for thumbnails

Project description

sphinxcontrib-images (formerly sphinxcontrib-fancybox).

Easy thumbnails in Sphinx documentation (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/sphinx-contrib/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 the 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.

Source Distribution

sphinxcontrib-images-0.9.4.tar.gz (116.9 kB view hashes)

Uploaded source

Built Distribution

sphinxcontrib_images-0.9.4-py2.py3-none-any.whl (118.7 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page