Create image galleries in Sphinx with Galleria

Go to file

Kujiu adaa36dcf0 Initial commit		2021-05-28 23:05:03 +02:00
sphinx_galleria	Initial commit	2021-05-28 23:05:03 +02:00
.gitignore	Initial commit	2021-05-27 21:49:56 +02:00
.gitmodules	Initial commit	2021-05-28 23:05:03 +02:00
CHANGES	Initial commit	2021-05-28 23:05:03 +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
README.rst	Initial commit	2021-05-28 23:05:03 +02:00
requirements.txt	Initial commit	2021-05-28 23:05:03 +02:00
setup.cfg	Initial commit	2021-05-28 23:05:03 +02:00
setup.py	Initial commit	2021-05-28 23:05:03 +02:00

README.rst

sphinx_galleria

Create image galleries with Sphinx.

Install

If you're using a virtualenv, just:

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:

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

</html>