From d676c2ee7b6207ff0b2a7b384052ab07c08bf43a Mon Sep 17 00:00:00 2001 From: mathieui Date: Sat, 13 Apr 2013 22:33:06 +0200 Subject: Move the plugins documentation (use automodule directive & docstrings) --- doc/source/plugins/index.rst | 72 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) (limited to 'doc/source/plugins/index.rst') 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 ` @@ -57,98 +60,167 @@ Plugin index Creates convenient aliases for MUC administration. Alias + :ref:`Documentation ` Allows you to create your own aliases. Amsg + :ref:`Documentation ` Allows a message to be broadcasted on all the rooms your are in. Caution: do not overuse. Day Change + :ref:`Documentation ` Logs the day change inside the buffers, to keep track of the days when backlogging. Display corrections + :ref:`Documentation ` Lists old versions of a corrected message. Exec + :ref:`Documentation ` Runs a system command an optionally sends the output as a message. Figlet + :ref:`Documentation ` Ascii-art writing (requires the ``figlet`` package on your system). GPG + :ref:`Documentation ` Allows encrypted exchanges and presence signing using GnuPG. IQ Show + :ref:`Documentation ` Shows the received IQs, for debugging purposes. Link + :ref:`Documentation ` Opens links in a web browser, locally or remotely using a FIFO and SSH. MPD Client + :ref:`Documentation ` Sends the current song (and optionally the progress inside the song) to the current (chat) tab. OTR + :ref:`Documentation ` Allows encrypted and deniable exchanges using OTR. PacoKick + :ref:`Documentation ` Kicks a random user in the room. Ping + :ref:`Documentation ` Sends a ping probe to an entity (XEP-0199) Quote + :ref:`Documentation ` 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 ` Sends your messages in rainbow colors using XHTML-IM. Reminder + :ref:`Documentation ` Reminds you to do something every now and then. Screen Detach + :ref:`Documentation ` Changes your status to _away_ if the screen poezio is in is detached. Simple notify + :ref:`Documentation ` Sends a notification with a command of your choice on (non-MUC) messages. Status + :ref:`Documentation ` Adds convenient aliases to /status (/away, etc). Tell + :ref:`Documentation ` Tells a message to a nick when he connects to a MUC. Uptime + :ref:`Documentation ` Gets the uptime of a XMPP server or a component. Replace + :ref:`Documentation ` Replace some patterns in your messages. Time Marker + :ref:`Documentation ` Display the time between two messages. + Revstr + :ref:`Documentation ` + + Reverse everything you say. + + Shuffle + :ref:`Documentation ` + + Shuffle everything you say. + + Double + :ref:`Documentation ` + + 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 -- cgit v1.2.3