sphinx_galleria
###############

Create image galleries with Sphinx.

Install
~~~~~~~

If you're using a virtualenv, just:

.. code:: bash

   pip install sphinx-galleria

Using
~~~~~

Add `'sphinx_galleria'` in the list of extensions in
your `source.conf` file.

Just use the galleria directive like this:

.. code:: rst

   .. galleria:: imagefile1 imagefile2  images*.jpg
      :galleria: (optional) Name of gallery
      :description: (optional) A long description
      :title: (optional) Title of image
      :thumbsize: (optional) Image size (defaults to "100x100")
      :transition: (optional, once) Transition for gallery
      :theme: (optional, once) Theme name for galleria
      :class: (optional, once) HTML class for gallery

Title, thumbnail size and description are same for all
images defined by the directive. If you need separated
descriptions and titles, just use the directive several
times with the same galleria name. In this case, theme
html class and transition must be defined only in
one directive.

Thumbnail size is in "WIDTHxHEIGHT" format, resulting
image keeps ratio.

Licensing
~~~~~~~~~

sphinx-galleria is under EUPL-1.2.