Skip to main content

Sphinx "images" extension

Project description

sphinxcontrib-images (formerly sphinxcontrib-fancybox).

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


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.4.2.tar.gz (58.6 kB view hashes)

Uploaded Source

Built Distributions

sphinxcontrib_images-0.4.2-py3.4.egg (58.3 kB view hashes)

Uploaded Source

sphinxcontrib_images-0.4.2-py3-none-any.whl (60.9 kB view hashes)

Uploaded Python 3

sphinxcontrib_images-0.4.2-py2.7.egg (58.1 kB view hashes)

Uploaded Source

sphinxcontrib_images-0.4.2-py2-none-any.whl (60.9 kB view hashes)

Uploaded Python 2

sphinxcontrib-images-0.4.2.linux-x86_64.tar.gz (63.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page