Fix hierarchy (and compilation warnings) for many plugins.

use/plugins/anonymous.rst

@@ -4,6 +4,9 @@
 The Anonymous plugin
 ====================
 
+Commands
+--------
+
 .. _command-channel-do:
 
 do <channel> <action>

use/plugins/badwords.rst

@@ -4,6 +4,9 @@
 The BadWords plugin
 ===================
 
+Commands
+--------
+
 .. _command-channel-list:
 
 list

use/plugins/brainfuck.rst

@@ -4,6 +4,9 @@
 The Brainfuck plugin
 ====================
 
+Commands
+--------
+
 .. _command-brainfuck-brainfuck:
 
 brainfuck brainfuck [--recover] [--input <characters>] <command>

use/plugins/channelstats.rst

@@ -4,6 +4,9 @@
 The ChannelStats plugin
 =======================
 
+Commands
+--------
+
 .. _command-channelstats-stats:
 
 channelstats stats [<channel>] [<name>]
@@ -44,7 +47,7 @@ Configuration
 supybot.plugins.ChannelStats.frowns
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Default value: [':|', ':-/', ':-\\', ':\\', ':/', ':(', ':-(', ":'("]
+Default value: [':\|', ':-/', ':-\\', ':\\', ':/', ':(', ':-(', ":'("]
 
 Determines what words (i.e., pieces of text with no spaces in them ) are considered 'frowns' for the purposes of stats-keeping.
 

use/plugins/ctcp.rst

@@ -4,6 +4,9 @@
 The Ctcp plugin
 ===============
 
+Command
+-------
+
 .. _command-ctcp-version:
 
 ctcp version [<channel>] [--nicks]

use/plugins/debian.rst

@@ -4,12 +4,8 @@
 The Debian plugin
 =================
 
-.. _command-debian-bold:
-
-debian bold
-^^^^^^^^^^^
-
-
+Commands
+--------
 
 .. _command-debian-file:
 
@@ -42,7 +38,7 @@ debian incoming [--{regexp,arch} <value>] [<glob> ...]
 
 Checks debian incoming for a matching package name.  The arch
 parameter defaults to i386; *--regexp* returns only those package names
-that match a given regexp, and normal matches use standard *nix
+that match a given regexp, and normal matches use standard \*nix
 globbing.
 
 .. _command-debian-version:

use/plugins/dict.rst

@@ -4,6 +4,9 @@
 The Dict plugin
 ===============
 
+Commands
+--------
+
 .. _command-dict-synonym:
 
 dict synonym <word> [<word> ...]

use/plugins/erepublik.rst

@@ -4,6 +4,9 @@
 The ERepublik plugin
 ====================
 
+Commands
+--------
+
 .. _command-erepublik-info:
 
 erepublik info <name|id>

use/plugins/eureka.rst

@@ -4,29 +4,17 @@
 The Eureka plugin
 =================
 
-.. _command-eureka-adjust:
+Start and stop
+--------------
 
-eureka adjust [<channel>] <nick> <number>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. _command-eureka-start:
 
-Increase or decrease the score of *<nick>* on the *<channel>*.
-If *<channel>* is not given, it defaults to the current channel.
+eureka start [<channel>]
+^^^^^^^^^^^^^^^^^^^^^^^^
 
-.. _command-eureka-resume:
-
-eureka resume [<channel>]
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Resume the Eureka on the given *<channel>*. If *<channel>* is not given,
+Start the Eureka on the given *<channel>*. If *<channel>* is not given,
 it defaults to the current channel.
 
-.. _command-eureka-skip:
-
-eureka skip [<channel>]
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Give up with this question, and switch to the next one.
-
 .. _command-eureka-stop:
 
 eureka stop [<channel>]
@@ -35,21 +23,6 @@ eureka stop [<channel>]
 Stop the Eureka on the given *<channel>*. If *<channel>* is not given,
 it defaults to the current channel.
 
-.. _command-eureka-clue:
-
-eureka clue [<channel>]
-^^^^^^^^^^^^^^^^^^^^^^^
-
-Give the next clue.
-
-.. _command-eureka-scores:
-
-eureka scores [<channel>]
-^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Return the scores on the *<channel>*. If *<channel>* is not given, it
-defaults to the current channel.
-
 .. _command-eureka-pause:
 
 eureka pause [<channel>]
@@ -58,14 +31,50 @@ eureka pause [<channel>]
 Pause the Eureka on the given *<channel>*. If *<channel>* is not given,
 it defaults to the current channel.
 
-.. _command-eureka-start:
+.. _command-eureka-resume:
 
-eureka start [<channel>]
-^^^^^^^^^^^^^^^^^^^^^^^^
+eureka resume [<channel>]
+^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Start the Eureka on the given *<channel>*. If *<channel>* is not given,
+Resume the Eureka on the given *<channel>*. If *<channel>* is not given,
 it defaults to the current channel.
 
+Moderation
+----------
+
+.. _command-eureka-adjust:
+
+eureka adjust [<channel>] <nick> <number>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Increase or decrease the score of *<nick>* on the *<channel>*.
+If *<channel>* is not given, it defaults to the current channel.
+
+.. _command-eureka-skip:
+
+eureka skip [<channel>]
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Give up with this question, and switch to the next one.
+
+.. _command-eureka-clue:
+
+eureka clue [<channel>]
+^^^^^^^^^^^^^^^^^^^^^^^
+
+Give the next clue.
+
+Scores
+------
+
+.. _command-eureka-scores:
+
+eureka scores [<channel>]
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Return the scores on the *<channel>*. If *<channel>* is not given, it
+defaults to the current channel.
+
 .. _command-eureka-score:
 
 eureka score [<channel>] <nick>
@@ -87,9 +96,6 @@ supybot.plugins.Eureka.format
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 
-
-
-
 .. _supybot.plugins.Eureka.format.score:
 
 supybot.plugins.Eureka.format.score

use/plugins/github.rst

@@ -4,6 +4,9 @@
 The GitHub plugin
 =================
 
+Main commands
+-------------
+
 .. _command-github-repo-info:
 
 github repo info <owner> <repository> [--enable <feature> <feature> ...] [--disable <feature> <feature>]
@@ -22,6 +25,9 @@ Searches the string in the repository names database. You can
 specify the page *<id>* of the results, and restrict the search
 to a particular programming *<language>*.
 
+Announces
+---------
+
 .. _command-github-announce-remove:
 
 github announce remove [<channel>] <owner> <name>

use/plugins/goodfrench.rst

@@ -4,6 +4,9 @@
 The GoodFrench plugin
 =====================
 
+Command
+-------
+
 .. _command-goodfrench-detect:
 
 goodfrench detect <texte>

use/plugins/internet.rst

@@ -4,6 +4,9 @@
 The Internet plugin
 ===================
 
+Commands
+--------
+
 .. _command-internet-whois:
 
 internet whois <domain>

use/plugins/lart.rst

@@ -4,6 +4,9 @@
 The Lart plugin
 ===============
 
+Command
+-------
+
 .. _command-lart-lart:
 
 lart lart [<channel>] [<id>] <who|what> [for <reason>]

use/plugins/later.rst

@@ -4,6 +4,9 @@
 The Later plugin
 ================
 
+Commands
+--------
+
 .. _command-later-notes:
 
 later notes [<nick>]

use/plugins/linkrelay.rst

@@ -4,6 +4,51 @@
 The LinkRelay plugin
 ====================
 
+Manage relays
+-------------
+
+.. _command-linkrelay-add:
+
+linkrelay add [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Adds a relay to the list. You must give at least *--from* or *--to;* if
+one of them is not given, it defaults to the current channel@network.
+Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
+given, everything is relayed.
+If *--reciprocal* is given, another relay will be added automatically,
+in the opposite direction.
+
+.. _command-linkrelay-remove:
+
+linkrelay remove [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Remove a relay from the list. You must give at least *--from* or *--to;* if
+one of them is not given, it defaults to the current channel@network.
+Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
+given, everything is relayed.
+If *--reciprocal* is given, another relay will be removed automatically,
+in the opposite direction.
+
+.. _command-linkrelay-list:
+
+linkrelay list
+^^^^^^^^^^^^^^
+
+Returns all the defined relay links
+
+Substitutes
+-----------
+
+.. _command-linkrelay-substitute:
+
+linkrelay substitute <regexp> <replacement>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Replaces all nicks that matches the *<regexp>* by the *<replacement>*
+string.
+
 .. _command-linkrelay-nosubstitute:
 
 linkrelay nosubstitute <regexp>
@@ -20,45 +65,6 @@ Returns the nicks of the people in the linked channels.
 *<channel>* is only necessary if the message
 isn't sent on the channel itself.
 
-.. _command-linkrelay-list:
-
-linkrelay list
-^^^^^^^^^^^^^^
-
-Returns all the defined relay links
-
-.. _command-linkrelay-remove:
-
-linkrelay remove [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Remove a relay from the list. You must give at least *--from* or *--to;* if
-one of them is not given, it defaults to the current channel@network.
-Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
-given, everything is relayed.
-If *--reciprocal* is given, another relay will be removed automatically,
-in the opposite direction.
-
-.. _command-linkrelay-add:
-
-linkrelay add [--from <channel>@<network>] [--to <channel>@<network>] [--regexp <regexp>] [--reciprocal]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Adds a relay to the list. You must give at least *--from* or *--to;* if
-one of them is not given, it defaults to the current channel@network.
-Only messages matching *<regexp>* will be relayed; if *<regexp>* is not
-given, everything is relayed.
-If *--reciprocal* is given, another relay will be added automatically,
-in the opposite direction.
-
-.. _command-linkrelay-substitute:
-
-linkrelay substitute <regexp> <replacement>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Replaces all nicks that matches the *<regexp>* by the *<replacement>*
-string.
-
 
 
 .. _plugin-linkrelay-config:

use/plugins/megahal.rst

@@ -1,29 +0,0 @@
-
-.. _plugin-megahal:
-
-The MegaHAL plugin
-==================
-
-Provides an interface to the MegaHAL chatterbot.
-
-.. WARNING::
-
-    This plugin is **highly** deprecated and unstable.
-
-    It may cause your bot to randomly uppercase some letters, and you'll
-    have to restart it to make it stop (temporaly).
-    This is particulary annoying, and you won't be able to identify,
-    because it uppercases letters in your password.
-    More over, only this bug has been noticed, but it may cause security
-    issues with your bot.
-
-    You shouldn't use it at all.
-
-.. include:: unofficial.inc
-
-.. _command-megahal-clean:
-
-clean
-^^^^^
-
-Saves MegaHAL brain to disk.

use/plugins/nickometer.rst

@@ -4,6 +4,9 @@
 The Nickometer plugin
 =====================
 
+Command
+-------
+
 .. _command-nickometer-nickometer:
 
 nickometer nickometer [<nick>]

use/plugins/plugindownloader.rst

@@ -4,6 +4,9 @@
 The PluginDownloader plugin
 ===========================
 
+Commands
+--------
+
 .. _command-plugindownloader-install:
 
 plugindownloader install <repository> <plugin>

use/plugins/praise.rst

@@ -4,6 +4,9 @@
 The Praise plugin
 =================
 
+Command
+-------
+
 .. _command-praise-praise:
 
 praise praise [<channel>] [<id>] <who|what> [for <reason>]

use/plugins/quote.rst

@@ -4,6 +4,9 @@
 The Quote plugin
 ================
 
+Command
+-------
+
 .. _command-quote-random:
 
 quote random [<channel>]

use/plugins/relay.rst

@@ -4,6 +4,9 @@
 The Relay plugin
 ================
 
+Commands
+--------
+
 .. _command-relay-nicks:
 
 relay nicks [<channel>]
@@ -13,15 +16,6 @@ Returns the nicks of the people in the channel on the various networks
 the bot is connected to. *<channel>* is only necessary if the message
 isn't sent on the channel itself.
 
-.. _command-relay-part:
-
-relay part <channel>
-^^^^^^^^^^^^^^^^^^^^
-
-Ceases relaying between the channel *<channel>* on all networks. The bot
-will part from the channel on all networks in which it is on the
-channel.
-
 .. _command-relay-join:
 
 relay join [<channel>]
@@ -34,6 +28,15 @@ relay between those channels unless he's told to join both
 channels. If *<channel>* is not given, starts relaying on the channel
 the message was sent in.
 
+.. _command-relay-part:
+
+relay part <channel>
+^^^^^^^^^^^^^^^^^^^^
+
+Ceases relaying between the channel *<channel>* on all networks. The bot
+will part from the channel on all networks in which it is on the
+channel.
+
 
 
 .. _plugin-relay-config:

use/plugins/reply.rst

@@ -4,6 +4,9 @@
 The Reply plugin
 ================
 
+Commands
+--------
+
 .. _command-reply-notice:
 
 reply notice <text>

use/plugins/scheduler.rst

@@ -4,6 +4,9 @@
 The Scheduler plugin
 ====================
 
+Commands
+--------
+
 .. _command-scheduler-repeat:
 
 scheduler repeat <name> <seconds> <command>

use/plugins/seeks.rst

@@ -4,6 +4,9 @@
 The Seeks plugin
 ================
 
+Command
+-------
+
 .. _command-seeks-search:
 
 seeks search <query>

use/plugins/seen.rst

@@ -4,6 +4,9 @@
 The Seen plugin
 ===============
 
+Commands
+--------
+
 .. _command-seen-user:
 
 seen user [<channel>] <name>

use/plugins/shrinkurl.rst

@@ -4,6 +4,9 @@
 The ShrinkUrl plugin
 ====================
 
+Commands
+--------
+
 .. _command-shrinkurl-xrl:
 
 shrinkurl xrl <url>

use/plugins/status.rst

@@ -4,6 +4,9 @@
 The Status plugin
 =================
 
+Commands
+--------
+
 .. _command-status-status:
 
 status status

use/plugins/sudo.rst

@@ -4,6 +4,9 @@
 The Sudo plugin
 ===============
 
+Commands
+--------
+
 .. _command-sudo-sudo:
 
 sudo sudo <commande> [<arg1> [<arg2> ...]]

use/plugins/supyml.rst

@@ -4,6 +4,9 @@
 The SupyML plugin
 =================
 
+Command
+-------
+
 .. _command-supyml-eval:
 
 supyml eval [--warnings] <SupyML script>

use/plugins/supysandbox.rst

@@ -4,22 +4,15 @@
 The SupySandbox plugin
 ======================
 
+Command
+-------
+
 .. _command-supysandbox-sandbox:
 
 supysandbox sandbox <code>
+^^^^^^^^^^^^^^^^^^^^^^^^^^
         
-        Runs Python code safely thanks to pysandbox
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-
-
-.. _command-supysandbox-runtests:
-
-supysandbox runtests
-^^^^^^^^^^^^^^^^^^^^
-
-
-
+Runs Python code safely thanks to pysandbox
 
 
 .. _plugin-supysandbox-config:

use/plugins/timebomb.rst

@@ -8,6 +8,9 @@ The timebomb game.
 
 .. include:: unofficial.inc
 
+Commands
+--------
+
 .. _command-timebomb-cutwire:
 
 timebomb cutwire <colored wire>

use/plugins/trivia.rst

@@ -8,6 +8,9 @@ The trivia game.
 
 .. include:: unofficial.inc
 
+Command
+-------
+
 .. _command-trivia-strivia:
 
 trivia strivia [<channel>]

use/plugins/twitter.rst

@@ -4,31 +4,8 @@
 The Twitter plugin
 ==================
 
-.. _command-twitter-friendslist:
-
-twitter friendslist [<channel>] [<user>]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Replies with the friends (i.e. people who one subscribes to) of the
-*<user>*. If *<user>* is not given, it defaults to the *<channel>*'s account.
-If *<channel>* is not given, it defaults to the current channel.
-
-.. _command-twitter-unfollow:
-
-twitter unfollow [<channel>] <user>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Unfollow a specified *<user>*
-If *<channel>* is not given, it defaults to the current channel.
-
-.. _command-twitter-replies:
-
-twitter replies [<channel>] [--since <oldest>]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Replies with the replies timeline.
-If *<channel>* is not given, it defaults to the current channel.
-If given, *--since* takes a tweet ID, used as a boundary
+Tweets
+--------
 
 .. _command-twitter-timeline:
 
@@ -44,13 +21,14 @@ If given, *--count* takes an integer, that stands for the number of
 tweets to display.
 If *--noretweet* is given, only native user's tweet will be displayed.
 
-.. _command-twitter-follow:
+.. _command-twitter-replies:
 
-twitter follow [<channel>] <user>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+twitter replies [<channel>] [--since <oldest>]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
-Follow a specified *<user>*
+Replies with the replies timeline.
 If *<channel>* is not given, it defaults to the current channel.
+If given, *--since* takes a tweet ID, used as a boundary
 
 .. _command-twitter-post:
 
@@ -78,6 +56,34 @@ twitter delete [<channel>] <id>
 Delete a specified status with id *<id>*
 If *<channel>* is not given, it defaults to the current channel.
 
+Friends
+-------
+
+.. _command-twitter-friendslist:
+
+twitter friendslist [<channel>] [<user>]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Replies with the friends (i.e. people who one subscribes to) of the
+*<user>*. If *<user>* is not given, it defaults to the *<channel>*'s account.
+If *<channel>* is not given, it defaults to the current channel.
+
+.. _command-twitter-unfollow:
+
+twitter unfollow [<channel>] <user>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Unfollow a specified *<user>*
+If *<channel>* is not given, it defaults to the current channel.
+
+.. _command-twitter-follow:
+
+twitter follow [<channel>] <user>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Follow a specified *<user>*
+If *<channel>* is not given, it defaults to the current channel.
+
 
 
 .. _plugin-twitter-config:

use/plugins/url.rst

@@ -4,6 +4,9 @@
 The URL plugin
 ==============
 
+Commands
+--------
+
 .. _command-url-stats:
 
 url stats [<channel>]

use/plugins/utilities.rst

@@ -4,6 +4,26 @@
 The Utilities plugin
 ====================
 
+Random
+------
+
+.. _command-utilities-shuffle:
+
+utilities shuffle <arg> [<arg> ...]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Shuffles the arguments given.
+
+.. _command-utilities-sample:
+
+utilities sample <num> <arg> [<arg> ...]
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Randomly chooses *<num>* items out of the arguments given.
+
+Programming/nesting
+-------------------
+
 .. _command-utilities-ignore:
 
 utilities ignore requires no arguments
@@ -12,13 +32,6 @@ utilities ignore requires no arguments
 Does nothing. Useful sometimes for sequencing commands when you don't
 care about their non-error return values.
 
-.. _command-utilities-shuffle:
-
-utilities shuffle <arg> [<arg> ...]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Shuffles the arguments given.
-
 .. _command-utilities-success:
 
 utilities success [<text>]
@@ -40,13 +53,6 @@ string(s) given to it; $nick (or $who), $randomNick, $randomInt,
 $botnick, $channel, $user, $host, $today, $now, and $randomDate are all
 handled appropriately.
 
-.. _command-utilities-sample:
-
-utilities sample <num> <arg> [<arg> ...]
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Randomly chooses *<num>* items out of the arguments given.
-
 .. _command-utilities-countargs:
 
 utilities countargs <arg> [<arg> ...]
@@ -54,6 +60,13 @@ utilities countargs <arg> [<arg> ...]
 
 Counts the arguments given.
 
+.. _command-utilities-apply:
+
+utilities apply <command> <text>
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Tokenizes *<text>* and calls *<command>* with the resulting arguments.
+
 .. _command-utilities-last:
 
 utilities last <text> [<text> ...]
@@ -63,13 +76,6 @@ Returns the last argument given. Useful when you'd like multiple
 nested commands to run, but only the output of the last one to be
 returned.
 
-.. _command-utilities-apply:
-
-utilities apply <command> <text>
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-Tokenizes *<text>* and calls *<command>* with the resulting arguments.
-
 
 
 .. _plugin-utilities-config:

use/plugins/wikitrans.rst

@@ -4,6 +4,9 @@
 The WikiTrans plugin
 ====================
 
+Command
+-------
+
 .. _command-wikitrans-translate:
 
 wikitrans translate <from language> <to language> <word>