From a3bf898c4d5052a8e7fbc0a429b95442803bce36 Mon Sep 17 00:00:00 2001 From: Simon Conseil Date: Mon, 26 Aug 2019 01:14:15 +0200 Subject: [PATCH] Improve docs --- docs/plugins.rst | 12 +++++++----- sigal/plugins/zip_gallery.py | 8 ++++---- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/docs/plugins.rst b/docs/plugins.rst index 70aac40..4da49dc 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -2,6 +2,8 @@ Plugins ========= +.. contents:: + How to use plugins ------------------ @@ -119,11 +121,6 @@ Nomedia plugin .. automodule:: sigal.plugins.nomedia -ZIP Gallery plugin -================== - -.. automodule:: sigal.plugins.zip_gallery - Upload to S3 plugin =================== @@ -133,3 +130,8 @@ Watermark plugin ================ .. automodule:: sigal.plugins.watermark + +ZIP Gallery plugin +================== + +.. automodule:: sigal.plugins.zip_gallery diff --git a/sigal/plugins/zip_gallery.py b/sigal/plugins/zip_gallery.py index 997505a..c5808cc 100644 --- a/sigal/plugins/zip_gallery.py +++ b/sigal/plugins/zip_gallery.py @@ -20,13 +20,13 @@ """ This plugin controls the generation of a ZIP archive for a gallery +If the ``zip_gallery`` setting is set, it contains the location of a zip +archive with all original images of the corresponding directory. + To ignore a ZIP gallery generation for a particular album, put a ``.nozip_gallery`` file next to it in its parent folder. Only the existence -of this ``.nozip_gallery`` file is tested. If no .nozip_gallery file is +of this ``.nozip_gallery`` file is tested. If no ``.nozip_gallery`` file is present, then make a ZIP archive with all media files. - -If the ``zip_gallery`` setting is set,it contains the location of a zip -archive with all original images of the corresponding directory. """ import logging