Document Irc, IrcState, ChannelState, IrcMsg, and Plugin.

develop/callbacks.rst

@@ -0,0 +1,18 @@
+.. _supybot-callbacks:
+
+*****************
+supybot.callbacks
+*****************
+
+Most used classes
+=================
+
+.. _supybot-callbacks-plugin:
+
+supybot.callbacks-plugin
+------------------------
+
+.. autoclass:: supybot.callbacks.Plugin
+    :members:
+    :inherited-members:
+

develop/index.rst

@@ -7,7 +7,7 @@ Developping plugins for Limnoria
 Doc provided with Supybot:
 
 .. toctree::
-    :maxdepth: 0
+    :maxdepth: 2
 
     ../import/PLUGIN_TUTORIAL.rst
     ../import/USING_WRAP.rst
@@ -20,7 +20,9 @@ Doc provided with Supybot:
 Other docs:
 
 .. toctree::
-    :maxdepth: 0
+    :maxdepth: 2
 
     callbacks.rst
+    irclib.rst
+    ircmsgs.rst
     httpserver.rst

develop/irclib.rst

@@ -0,0 +1,44 @@
+.. _supybot-irclib:
+
+**************
+supybot.irclib
+**************
+
+Most used classes
+=================
+
+.. _supybot-irclib-irc:
+
+supybot.irclib.Irc
+------------------
+
+It is usually the `irc` object given to plugin commands.
+
+.. autoclass:: supybot.irclib.Irc
+    :members:
+    :inherited-members:
+
+
+.. _supybot-irclib-ircstate:
+
+supybot.irclib.IrcState
+-----------------------
+
+Used mainly as the `state` attribute of :py:class:`supybot.irclib.Irc` objects.
+
+.. autoclass:: supybot.irclib.IrcState
+    :members:
+    :inherited-members:
+
+
+.. _supybot-irclib-channelstate:
+
+supybot.irclib.ChannelState
+---------------------------
+
+Used mainly as the `channels['#chan']` attribute of
+:py:class:`supybot.irclib.Irc` objects.
+
+.. autoclass:: supybot.irclib.ChannelState
+    :members:
+    :inherited-members:

develop/ircmsgs.rst

@@ -0,0 +1,8 @@
+.. _supybot-ircmsgs:
+
+***************
+supybot.ircmsgs
+***************
+
+.. automodule:: supybot.ircmsgs
+    :members: