sphinx: document plugins

[sid.git] / sid / feeds.py

diff --git a/sid/feeds.py b/sid/feeds.py
index 64ddf1217300b548ded94d947a14cc22aba3b9af..7fba4e25151b390d6c46370b26d28f05efbf8e24 100644 (file)
--- a/sid/feeds.py
+++ b/sid/feeds.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 
-# Copyright (C) 2011, 2014 kaliko <kaliko@azylum.org>
+# Copyright (C) 2011, 2014, 2020 kaliko <kaliko@azylum.org>
 
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -134,7 +134,14 @@ class FeedMonitor(threading.Thread):
 
 
 class Feeds(Plugin):
+    """
+    .. note::
+      Feeds plugin depends on external module: **feedparser**
+    """
+
+    #: Time between feeds check
     TEMPO = 60
+    #: Default feeds to monitor
     FEEDS = [
         'https://www.debian.org/security/dsa',
         'https://www.debian.org/News/news',
@@ -157,8 +164,11 @@ class Feeds(Plugin):
     @botcmd
     def feeds(self, rcv, args):
         """feeds monitors debian project related feeds.
-        !feeds : registred feeds list
-        !feeds last : last check time"""
+
+        **commands**:
+
+        * ``!feeds`` : registred feeds list
+        * ``!feeds last`` : last check time"""
         if 'last' in args:
             self.reply(rcv, 'Last feeds check: %s' % self.th_mon.last_check)
             return