From e50cfad04dd5f3f2b72190dcc4bec497417831aa Mon Sep 17 00:00:00 2001 From: Valentin Lorentz Date: Thu, 31 Jan 2013 20:49:31 +0100 Subject: [PATCH] Document Irc, IrcState, ChannelState, IrcMsg, and Plugin. --- develop/callbacks.rst | 18 ++++++++++++++++++ develop/index.rst | 6 ++++-- develop/irclib.rst | 44 +++++++++++++++++++++++++++++++++++++++++++ develop/ircmsgs.rst | 8 ++++++++ 4 files changed, 74 insertions(+), 2 deletions(-) create mode 100644 develop/callbacks.rst create mode 100644 develop/irclib.rst create mode 100644 develop/ircmsgs.rst diff --git a/develop/callbacks.rst b/develop/callbacks.rst new file mode 100644 index 0000000..676a77f --- /dev/null +++ b/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: + diff --git a/develop/index.rst b/develop/index.rst index 52beffd..7d2211d 100644 --- a/develop/index.rst +++ b/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 diff --git a/develop/irclib.rst b/develop/irclib.rst new file mode 100644 index 0000000..489175d --- /dev/null +++ b/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: diff --git a/develop/ircmsgs.rst b/develop/ircmsgs.rst new file mode 100644 index 0000000..f49fb5f --- /dev/null +++ b/develop/ircmsgs.rst @@ -0,0 +1,8 @@ +.. _supybot-ircmsgs: + +*************** +supybot.ircmsgs +*************** + +.. automodule:: supybot.ircmsgs + :members: