Added more documentation

docs/conf.py

@@ -81,7 +81,7 @@
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'tango'
 
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
@@ -148,10 +148,10 @@
 #html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+html_show_sphinx = False
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 #html_show_copyright = True

docs/index.rst

@@ -4,14 +4,18 @@ IRCUtils |version|
 It's designed for ease of use for anything you'd need. It also has fast and 
 simple support for writing bots.
 
+.. note::
+   These docs were last updated on |today|. Documentation is being added daily,
+   so be sure to check back again in the future. If there is documentation
+   that you wish to request, 
+   `file a ticket </projects/ircutils/newticket>`_ on the project page.
 
-Document contents
------------------
 
+Getting started
+----------------
 .. toctree::
    :maxdepth: 2
 
-   intro
    installation
    tutorial
    bot
@@ -24,10 +28,9 @@ Document contents
    ident
 
 
-Indices and tables
-------------------
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
 
+Reporting a bug
+---------------
+`Create a bug report </projects/ircutils/newticket?type=defect>`_ on the 
+IRCUtils project page. If you have a solution to the bug, you are encouraged 
+to include it in your report.

docs/installation.rst

@@ -5,16 +5,17 @@ IRCUtils is designed to be compatible with both Windows systems and Linux.
 
 Installing on Windows
 ---------------------
- 1. Navigate to http://dev.guardedcode.com/projects/ircutils and download the 
-    newest version of IRCUtils as a windows installer.
+ 1. Download the 
+    `windows installer </download/ircutils/ircutils-0.1.1.exe>`_.
  2. Execute the installer and follow the instructions.
  3. To make sure everything is working, open up a Python console and type 
     ``import ircutils`` to ensure it has been installed.
 
+
 Installing from source
 ----------------------
- 1. Navigate to http://dev.guardedcode.com/projects/ircutils grab a copy of the
-    tar.gz compressed source of the newest version.
+ 1. Download the 
+    `compressed source </download/ircutils/ircutils-0.1.1.tar.gz>`_.
  2. ``tar -xsf ircutils-0.1.1.tar.gz``
  3. ``cd ircutils-0.1.1/``
  4. ``python setup.py install``

docs/tutorial.rst

@@ -1,7 +1,10 @@
-The 5-Minute Tutorial
+Tutorial
 =====================
-
 Let's start off with something simple. 
+
+
+Getting warmed up
+-----------------
 It'll be an IRC bot that that simply responds to any channel message with that 
 same message. We'll call it `EchoBot`. 
 
@@ -15,16 +18,13 @@ Next, we'll use the SimpleBot class to build upon::
     from ircutils import bot
 
     class EchoBot(bot.SimpleBot):
+        # The bot is currently empty
+        # We'll add event handlers next!
         pass
 
-    if __name__ == "__main__":
-        echo = EchoBot("echobot")
-        echo.connect("irc.freenode.com")
-        echo.start()
-
-Right now, we actually have a working IRC bot; however, it doesn't do anything 
-other than connect to the server. Let's tell it to connect to #ircutils once it 
-receives the IRC welcome message::
+Right now, we actually have a working IRC bot; however, it isn't able to respond
+to any events since we haven't added any event handlers.
+Let's tell it to connect to #ircutils once it receives the IRC welcome message::
 
     from ircutils import bot
 
@@ -33,11 +33,6 @@ receives the IRC welcome message::
         def on_welcome(self, event):
             self.join("#ircutils")
 
-    if __name__ == "__main__":
-        echo = EchoBot("echobot")
-        echo.connect("irc.freenode.com")
-        echo.start()
-
 Finally, let's provide a handler that any time it recieves a message on a 
 channel, it outputs that same message to that same channel::
 
@@ -51,13 +46,34 @@ channel, it outputs that same message to that same channel::
         def on_channel_message(self, event):
             self.send_message(event.target, event.message)
 
+Done! This bot will successfully do what we specified. Let's add some code to
+run it::
+
+    from ircutils import bot
+
+    class EchoBot(bot.SimpleBot):
+        
+        def on_welcome(self, event):
+            self.join("#ircutils")
+
+        def on_channel_message(self, event):
+            self.send_message(event.target, event.message)
+    
     if __name__ == "__main__":
-        echo = EchoBot("echobot")
-        echo.connect("irc.freenode.com")
+        # Create an instance of the bot
+        # We set the bot's nickname here
+        echo = EchoBot("echo_bot") 
+        
+        # Let's connect to the host
+        echo.connect("irc.freenode.com", 6667)
+        
+        # Start running the bot
         echo.start()
 
-Done! This bot will successfully do what we specified. Run it and make sure 
-everything is working! But hey, that's a bit boring. Let's make it send an 
+
+Kick it up a notch
+------------------
+But hey, that's a bit boring. Let's make it send an 
 action whenever it joins a channel, and welcome anybody who joins::
 
     from ircutils import bot
@@ -76,9 +92,4 @@ action whenever it joins a channel, and welcome anybody who joins::
         def on_channel_message(self, event):
             self.send_message(event.target, event.message)
 
-    if __name__ == "__main__":
-        echo = EchoBot("echobot")
-        echo.connect("irc.freenode.com")
-        echo.start()
-
 That's it! 

ircutils/events.py

@@ -1,9 +1,4 @@
-""" 
-    Events and event listeners.
-    
-    Author:        Evan Fosmark <me@evanfosmark.com>
-    Description:   This module gets used by client.py for event handling and 
-                   management.
+""" This module gets used by client.py for event handling and management.
 """
 import bisect
 import collections