From 33f7d331d058d2085e007a5dec89934ca1565234 Mon Sep 17 00:00:00 2001
From: Simon Conseil <contact@saimon.org>
Date: Sat, 6 Dec 2014 23:08:46 +0100
Subject: [PATCH] Add the media_page plugin to the docs.

---
 docs/plugins.rst            |  5 +++++
 sigal/plugins/media_page.py | 10 ++++++++--
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/docs/plugins.rst b/docs/plugins.rst
index d33a08d..d191aac 100644
--- a/docs/plugins.rst
+++ b/docs/plugins.rst
@@ -94,6 +94,11 @@ Copyright plugin
 
 .. automodule:: sigal.plugins.copyright
 
+Media page plugin
+=================
+
+.. automodule:: sigal.plugins.media_page
+
 Upload to S3 plugin
 ===================
 
diff --git a/sigal/plugins/media_page.py b/sigal/plugins/media_page.py
index 58e2a88..186bcbf 100644
--- a/sigal/plugins/media_page.py
+++ b/sigal/plugins/media_page.py
@@ -21,13 +21,19 @@
 # FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 # IN THE SOFTWARE.
 
-import os
+"""Plugin which generates HTML pages for each image.
+
+Currently this plugin can be used only with the colorbox theme, the other
+themes have to be adapted.
+
+For themes, the ``previous_media`` and ``next_media`` variables contain the
+previous/next :class:`~sigal.gallery.Media` objects.
 
-"""Plugin which generates pages for each image.
 """
 
 import codecs
 import logging
+import os
 
 from sigal import signals
 from sigal.writer import Writer