Move the plugins documentation

(use automodule directive & docstrings)

30 files changed, 237 insertions, 4 deletions

diff --git a/doc/source/index.rst b/doc/source/index.rst
index f1eff613..1f2ce3f3 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -20,7 +20,7 @@ Poezio documentation
     dev/index
 
 ..
-    plugins
+    plugins/index
     dev
 
 Indices and tables
diff --git a/doc/source/plugins/admin.rst b/doc/source/plugins/admin.rst
index fc5875b4..5cd6c77c 100644
--- a/doc/source/plugins/admin.rst
+++ b/doc/source/plugins/admin.rst
@@ -1,7 +1,6 @@
 .. _admin-plugin:
 
-Room administration plugin
-==========================
-
+Admin
+=====
 
 .. automodule:: admin
diff --git a/doc/source/plugins/alias.rst b/doc/source/plugins/alias.rst
new file mode 100644
index 00000000..0832576e
--- /dev/null
+++ b/doc/source/plugins/alias.rst
@@ -0,0 +1,6 @@
+.. _alias-plugin:
+
+Alias
+=====
+
+.. automodule:: alias
diff --git a/doc/source/plugins/amsg.rst b/doc/source/plugins/amsg.rst
new file mode 100644
index 00000000..2a785034
--- /dev/null
+++ b/doc/source/plugins/amsg.rst
@@ -0,0 +1,6 @@
+.. _amsg-plugin:
+
+Amsg
+====
+
+.. automodule:: amsg
diff --git a/doc/source/plugins/day_change.rst b/doc/source/plugins/day_change.rst
new file mode 100644
index 00000000..5893b1f7
--- /dev/null
+++ b/doc/source/plugins/day_change.rst
@@ -0,0 +1,6 @@
+.. _daychange-plugin:
+
+Day change
+==========
+
+.. automodule:: day_change
diff --git a/doc/source/plugins/display_corrections.rst b/doc/source/plugins/display_corrections.rst
new file mode 100644
index 00000000..5046a76e
--- /dev/null
+++ b/doc/source/plugins/display_corrections.rst
@@ -0,0 +1,6 @@
+.. _displaycorrections-plugin:
+
+Display corrections
+===================
+
+.. automodule:: display_corrections
diff --git a/doc/source/plugins/double.rst b/doc/source/plugins/double.rst
new file mode 100644
index 00000000..e40fa575
--- /dev/null
+++ b/doc/source/plugins/double.rst
@@ -0,0 +1,6 @@
+.. _double-plugin:
+
+Double
+======
+
+.. automodule:: double
diff --git a/doc/source/plugins/exec.rst b/doc/source/plugins/exec.rst
new file mode 100644
index 00000000..3183e9bc
--- /dev/null
+++ b/doc/source/plugins/exec.rst
@@ -0,0 +1,6 @@
+.. _exec-plugin:
+
+Exec
+=====
+
+.. automodule:: exec
diff --git a/doc/source/plugins/figlet.rst b/doc/source/plugins/figlet.rst
new file mode 100644
index 00000000..c1490e1b
--- /dev/null
+++ b/doc/source/plugins/figlet.rst
@@ -0,0 +1,6 @@
+.. _figlet-plugin:
+
+Figlet
+======
+
+.. automodule:: figlet
diff --git a/doc/source/plugins/gpg.rst b/doc/source/plugins/gpg.rst
new file mode 100644
index 00000000..747d8cb8
--- /dev/null
+++ b/doc/source/plugins/gpg.rst
@@ -0,0 +1,6 @@
+.. _gpg-plugin:
+
+GPG
+===
+
+.. automodule:: gpg
diff --git a/doc/source/plugins/index.rst b/doc/source/plugins/index.rst
index 5af1d7e0..7aad64c8 100644
--- a/doc/source/plugins/index.rst
+++ b/doc/source/plugins/index.rst
@@ -27,6 +27,8 @@ e.g.
 
     plugins_autoload = gpg:tell:exec
 
+.. _plugin-configuration:
+
 Plugin configuration
 --------------------
 
@@ -50,6 +52,7 @@ Plugin index
 ------------
 
 .. glossary::
+    :sorted:
 
     Admin
         :ref:`Documentation <admin-plugin>`
@@ -57,98 +60,167 @@ Plugin index
         Creates convenient aliases for MUC administration.
 
     Alias
+        :ref:`Documentation <alias-plugin>`
 
         Allows you to create your own aliases.
 
     Amsg
+        :ref:`Documentation <amsg-plugin>`
 
         Allows a message to be broadcasted on all the rooms your are in.
         Caution: do not overuse.
 
     Day Change
+        :ref:`Documentation <daychange-plugin>`
 
         Logs the day change inside the buffers, to keep track of the days when
         backlogging.
 
     Display corrections
+        :ref:`Documentation <displaycorrections-plugin>`
 
         Lists old versions of a corrected message.
 
     Exec
+        :ref:`Documentation <exec-plugin>`
 
         Runs a system command an optionally sends the output as a message.
 
     Figlet
+        :ref:`Documentation <figlet-plugin>`
 
         Ascii-art writing (requires the ``figlet`` package on your system).
 
     GPG
+        :ref:`Documentation <gpg-plugin>`
 
         Allows encrypted exchanges and presence signing using GnuPG.
 
     IQ Show
+        :ref:`Documentation <iqshow-plugin>`
 
         Shows the received IQs, for debugging purposes.
 
     Link
+        :ref:`Documentation <link-plugin>`
 
         Opens links in a web browser, locally or remotely using a FIFO and SSH.
 
     MPD Client
+        :ref:`Documentation <mpdclient-plugin>`
 
         Sends the current song (and optionally the progress inside the song) to
         the current (chat) tab.
 
     OTR
+        :ref:`Documentation <otr-plugin>`
 
         Allows encrypted and deniable exchanges using OTR.
 
     PacoKick
+        :ref:`Documentation <pacokick-plugin>`
 
         Kicks a random user in the room.
 
     Ping
+        :ref:`Documentation <ping-plugin>`
 
         Sends a ping probe to an entity (XEP-0199)
 
     Quote
+        :ref:`Documentation <quote-plugin>`
 
         Adds a /quote command to quote a message at HH:MM:SS and put it in the
         input (to prevent painful copy/pastes).
 
     Rainbow
+        :ref:`Documentation <rainbow-plugin>`
 
         Sends your messages in rainbow colors using XHTML-IM.
 
     Reminder
+        :ref:`Documentation <reminder-plugin>`
 
         Reminds you to do something every now and then.
 
     Screen Detach
+        :ref:`Documentation <screendetach-plugin>`
 
         Changes your status to _away_ if the screen poezio is in is detached.
 
     Simple notify
+        :ref:`Documentation <simplenotify-plugin>`
 
         Sends a notification with a command of your choice on (non-MUC) messages.
 
     Status
+        :ref:`Documentation <status-plugin>`
 
         Adds convenient aliases to /status (/away, etc).
 
     Tell
+        :ref:`Documentation <tell-plugin>`
 
         Tells a message to a nick when he connects to a MUC.
 
     Uptime
+        :ref:`Documentation <uptime-plugin>`
 
         Gets the uptime of a XMPP server or a component.
 
     Replace
+        :ref:`Documentation <replace-plugin>`
 
         Replace some patterns in your messages.
 
     Time Marker
+        :ref:`Documentation <timemarker-plugin>`
 
         Display the time between two messages.
 
+    Revstr
+        :ref:`Documentation <revstr-plugin>`
+
+        Reverse everything you say.
+
+    Shuffle
+        :ref:`Documentation <shuffle-plugin>`
+
+        Shuffle everything you say.
+
+    Double
+        :ref:`Documentation <double-plugin>`
+
+        Double the first word of each sentence.
+
+.. toctree::
+    :hidden:
+
+    admin
+    alias
+    amsg
+    day_change
+    display_corrections
+    exec
+    figlet
+    gpg
+    link
+    mpd_client
+    otr
+    pacokick
+    ping
+    quote
+    rainbow
+    reminder
+    replace
+    screen_detach
+    send_delayed
+    simple_notify
+    status
+    tell
+    time_marker
+    uptime
+    revstr
+    double
+    shuffle
+    iq_show
diff --git a/doc/source/plugins/iq_show.rst b/doc/source/plugins/iq_show.rst
new file mode 100644
index 00000000..29ba420e
--- /dev/null
+++ b/doc/source/plugins/iq_show.rst
@@ -0,0 +1,6 @@
+.. _iqshow-plugin:
+
+Iq show
+=======
+
+.. automodule:: iq_show
diff --git a/doc/source/plugins/link.rst b/doc/source/plugins/link.rst
new file mode 100644
index 00000000..deac6f86
--- /dev/null
+++ b/doc/source/plugins/link.rst
@@ -0,0 +1,6 @@
+.. _link-plugin:
+
+Link
+====
+
+.. automodule:: link
diff --git a/doc/source/plugins/mpd_client.rst b/doc/source/plugins/mpd_client.rst
new file mode 100644
index 00000000..e6ee2399
--- /dev/null
+++ b/doc/source/plugins/mpd_client.rst
@@ -0,0 +1,6 @@
+.. _mpdclient-plugin:
+
+Mpd client
+==========
+
+.. automodule:: mpd_client
diff --git a/doc/source/plugins/otr.rst b/doc/source/plugins/otr.rst
new file mode 100644
index 00000000..f48eba96
--- /dev/null
+++ b/doc/source/plugins/otr.rst
@@ -0,0 +1,6 @@
+.. _otr-plugin:
+
+OTR
+===
+
+.. automodule:: otr
diff --git a/doc/source/plugins/pacokick.rst b/doc/source/plugins/pacokick.rst
new file mode 100644
index 00000000..df84eea6
--- /dev/null
+++ b/doc/source/plugins/pacokick.rst
@@ -0,0 +1,6 @@
+.. _pacokick-plugin:
+
+Pacokick
+========
+
+.. automodule:: pacokick
diff --git a/doc/source/plugins/ping.rst b/doc/source/plugins/ping.rst
new file mode 100644
index 00000000..cef72f6e
--- /dev/null
+++ b/doc/source/plugins/ping.rst
@@ -0,0 +1,6 @@
+.. _ping-plugin:
+
+Ping
+====
+
+.. automodule:: ping
diff --git a/doc/source/plugins/quote.rst b/doc/source/plugins/quote.rst
new file mode 100644
index 00000000..fb1ac2d0
--- /dev/null
+++ b/doc/source/plugins/quote.rst
@@ -0,0 +1,6 @@
+.. _quote-plugin:
+
+Quote
+=====
+
+.. automodule:: quote
diff --git a/doc/source/plugins/rainbow.rst b/doc/source/plugins/rainbow.rst
new file mode 100644
index 00000000..fb01e8de
--- /dev/null
+++ b/doc/source/plugins/rainbow.rst
@@ -0,0 +1,6 @@
+.. _rainbow-plugin:
+
+Rainbow
+=======
+
+.. automodule:: rainbow
diff --git a/doc/source/plugins/reminder.rst b/doc/source/plugins/reminder.rst
new file mode 100644
index 00000000..cbf73470
--- /dev/null
+++ b/doc/source/plugins/reminder.rst
@@ -0,0 +1,6 @@
+.. _reminder-plugin:
+
+Reminder
+========
+
+.. automodule:: reminder
diff --git a/doc/source/plugins/replace.rst b/doc/source/plugins/replace.rst
new file mode 100644
index 00000000..5c7c594b
--- /dev/null
+++ b/doc/source/plugins/replace.rst
@@ -0,0 +1,6 @@
+.. _replace-plugin:
+
+Replace
+=======
+
+.. automodule:: replace
diff --git a/doc/source/plugins/revstr.rst b/doc/source/plugins/revstr.rst
new file mode 100644
index 00000000..bff5b660
--- /dev/null
+++ b/doc/source/plugins/revstr.rst
@@ -0,0 +1,6 @@
+.. _revstr-plugin:
+
+Revstr
+======
+
+.. automodule:: revstr
diff --git a/doc/source/plugins/screen_detach.rst b/doc/source/plugins/screen_detach.rst
new file mode 100644
index 00000000..d080c113
--- /dev/null
+++ b/doc/source/plugins/screen_detach.rst
@@ -0,0 +1,6 @@
+.. _screendetach-plugin:
+
+Screen detach
+=============
+
+.. automodule:: screen_detach
diff --git a/doc/source/plugins/send_delayed.rst b/doc/source/plugins/send_delayed.rst
new file mode 100644
index 00000000..c2b3e681
--- /dev/null
+++ b/doc/source/plugins/send_delayed.rst
@@ -0,0 +1,6 @@
+.. _senddelayed-plugin:
+
+Send delayed
+============
+
+.. automodule:: send_delayed
diff --git a/doc/source/plugins/shuffle.rst b/doc/source/plugins/shuffle.rst
new file mode 100644
index 00000000..ef987deb
--- /dev/null
+++ b/doc/source/plugins/shuffle.rst
@@ -0,0 +1,6 @@
+.. _shuffle-plugin:
+
+Shuffle
+=======
+
+.. automodule:: shuffle
diff --git a/doc/source/plugins/simple_notify.rst b/doc/source/plugins/simple_notify.rst
new file mode 100644
index 00000000..78a45909
--- /dev/null
+++ b/doc/source/plugins/simple_notify.rst
@@ -0,0 +1,6 @@
+.. _simplenotify-plugin:
+
+Simple notify
+=============
+
+.. automodule:: simple_notify
diff --git a/doc/source/plugins/status.rst b/doc/source/plugins/status.rst
new file mode 100644
index 00000000..7891ecc2
--- /dev/null
+++ b/doc/source/plugins/status.rst
@@ -0,0 +1,6 @@
+.. _status-plugin:
+
+Status
+======
+
+.. automodule:: status
diff --git a/doc/source/plugins/tell.rst b/doc/source/plugins/tell.rst
new file mode 100644
index 00000000..7f52db73
--- /dev/null
+++ b/doc/source/plugins/tell.rst
@@ -0,0 +1,6 @@
+.. _tell-plugin:
+
+Tell
+====
+
+.. automodule:: tell
diff --git a/doc/source/plugins/time_marker.rst b/doc/source/plugins/time_marker.rst
new file mode 100644
index 00000000..95552e1a
--- /dev/null
+++ b/doc/source/plugins/time_marker.rst
@@ -0,0 +1,6 @@
+.. _timemarker-plugin:
+
+Time marker
+===========
+
+.. automodule:: time_marker
diff --git a/doc/source/plugins/uptime.rst b/doc/source/plugins/uptime.rst
new file mode 100644
index 00000000..94e38c28
--- /dev/null
+++ b/doc/source/plugins/uptime.rst
@@ -0,0 +1,6 @@
+.. _uptime-plugin:
+
+Uptime
+======
+
+.. automodule:: uptime