Create image galleries in Sphinx with Galleria

Find a file

kujiu (@uberwald) cb1f25e145 Fix CSS for image size		2023-08-17 22:14:33 +02:00
sphinx_galleria	Fix CSS for image size	2023-08-17 22:14:33 +02:00
.gitignore	Mobile and swipe support	2021-07-25 01:54:37 +02:00
.gitmodules	Initial commit	2021-05-28 23:05:03 +02:00
babel.cfg	Fix: CSS issues, keyboard shortcuts, group galleries	2021-06-02 23:58:10 +02:00
CHANGES.rst	Use image node	2023-08-17 21:57:17 +02:00
LICENSE	Initial commit	2021-05-27 21:49:56 +02:00
LICENSE-de	Initial commit	2021-05-28 23:05:03 +02:00
LICENSE-fr	Initial commit	2021-05-28 23:05:03 +02:00
LICENSE-nl	Initial commit	2021-05-28 23:05:03 +02:00
pyproject.toml	Use image node	2023-08-17 21:57:17 +02:00
README.rst	Use JPEG instead of PNG on thumbnails	2021-07-25 15:16:10 +02:00

README.rst

sphinx_galleria

Create image galleries with Sphinx. No external JS dependency.

Install

If you're using a virtualenv, just:

System Message: WARNING/2 (<stdin>, line 12)

Cannot analyze code. Pygments package not found.

.. 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:

System Message: WARNING/2 (<stdin>, line 29)

Cannot analyze code. Pygments package not found.

.. code:: rst

   .. galleria:: imagefile1 imagefile2  images*.jpg
      :galleria: (optional) Name of gallery - node level
      :alt: (optional) A long description - image level
      :title: (optional) Title of image - image level
      :thumbsize: (optional) Image size (defaults to "100x100") - image level
      :width: Width of image (in pixel or percentage or with unit, default auto) - node level
      :height: (optional) Height of image (in pixel or with unit) - node level
      :align: Align to 'right', 'left' or 'center' (default to center) - node level
      :hide_title: Flag - hide title under image (not in dialog) - image level
      :hide_alt: Flag - hide alternative text under image - image level
      :no_transition: Flag - avoid transition effect - node level
      :timer: (optional) Go to next image each timer seconds
      :class: (optional) HTML class for gallery - node level

Image level options 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, node level options must be defined only once.

Thumbnail size is in "WIDTHxHEIGHT" format, resulting image keeps ratio. Be careful with tumbnail size, the browser loads all thumbnails of a gallery when loading the page. It can take some time with really big galleries.

The first image of a gallery is displayed if javascript is not available on the browser.

Licensing

sphinx-galleria is under EUPL-1.2.