From 8185354bacc0cf1583c35caff021ebc87e986ef0 Mon Sep 17 00:00:00 2001
From: Bowen Ding <dbw9580@live.com>
Date: Tue, 14 Apr 2020 17:52:02 +0800
Subject: [PATCH] Update doc

---
 docs/plugins.rst                 | 9 +++++----
 sigal/plugins/encrypt/encrypt.py | 8 ++++++++
 sigal/plugins/zip_gallery.py     | 2 ++
 3 files changed, 15 insertions(+), 4 deletions(-)

diff --git a/docs/plugins.rst b/docs/plugins.rst
index ad8771b..3ddc5fd 100644
--- a/docs/plugins.rst
+++ b/docs/plugins.rst
@@ -101,6 +101,11 @@ Copyright plugin
 
 .. automodule:: sigal.plugins.copyright
 
+Encrypt plugin
+==============
+
+.. automodule:: sigal.plugins.encrypt
+
 Extended caching plugin
 =======================
 
@@ -136,7 +141,3 @@ ZIP Gallery plugin
 
 .. automodule:: sigal.plugins.zip_gallery
 
-Encrypt plugin
-==============
-
-.. automodule:: sigal.plugins.encrypt
diff --git a/sigal/plugins/encrypt/encrypt.py b/sigal/plugins/encrypt/encrypt.py
index 8163811..0e71a71 100644
--- a/sigal/plugins/encrypt/encrypt.py
+++ b/sigal/plugins/encrypt/encrypt.py
@@ -49,6 +49,14 @@ the first build, so that incremental builds can share the same credentials.
 DO NOT CHANGE THE PASSWORD OR OTHER CRYPTOGRAPHIC PARAMETERS ONCE A GALLERY IS 
 BUILT, or there will be inconsistency in encrypted files and viewers will not be able
 to see some of the images any more.
+
+.. _compatibility-with-encrypt:
+
+Compatibility with other plugins:
+
+- ``zip_gallery``: if you enable both this plugin and the ``zip_gallery`` plugin, 
+  the generated zip archives will contain encrypted images, which is generally 
+  meaningless since viewers cannot easily decrypt them outside a browser.
 '''
 
 import os
diff --git a/sigal/plugins/zip_gallery.py b/sigal/plugins/zip_gallery.py
index 9d2f1f2..2695db6 100644
--- a/sigal/plugins/zip_gallery.py
+++ b/sigal/plugins/zip_gallery.py
@@ -27,6 +27,8 @@ 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
 present, then make a ZIP archive with all media files.
+
+See :ref:`compatibility with the encrypt plugin <compatibility-with-encrypt>`.
 """
 
 import logging