Improve docs

This commit is contained in:
Simon Conseil
2019-08-26 01:14:15 +02:00
parent 1d79e3f7a5
commit a3bf898c4d
2 changed files with 11 additions and 9 deletions

View File

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

View File

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