Update documentation

docs/bot.rst

@@ -2,13 +2,7 @@
     :maxdepth: 4
     
 Bot
----
+===
 .. automodule:: irc_api.bot
 	:ignore-module-all:
 
-	.. autoclass:: Bot
-	.. autoclass:: BotCommand
-	.. autoexception:: WrongArg
-	.. autofunction:: check_args
-	.. autofunction:: convert	
-	.. autofunction:: parse

docs/commands.rst

@@ -2,14 +2,8 @@
     :maxdepth: 4
     
 Commands
---------
+========
 .. automodule:: irc_api.commands
     :ignore-module-all:
-    
-    .. autodecorator:: command
-    .. autodecorator:: channel
-    .. autodecorator:: every
-    .. autodecorator:: on
-    .. autodecorator:: user
-    .. autofunction:: auto_help
+
 

docs/history.rst

@@ -2,8 +2,6 @@
     :maxdepth: 4
     
 History
--------
+=======
 .. automodule:: irc_api.history
 	:ignore-module-all:
-	
-	.. autoclass:: History

docs/irc.rst

@@ -2,9 +2,7 @@
     :maxdepth: 4
     
 IRC
----
+===
 .. automodule:: irc_api.irc
    	:ignore-module-all:
-   	
-   	.. autoclass:: IRC
 

docs/message.rst

@@ -2,8 +2,6 @@
     :maxdepth: 4
     
 Message
--------
+=======
 .. automodule:: irc_api.message
     :ignore-module-all:
-    
-    .. autoclass:: Message

src/irc_api/bot.py

@@ -1,4 +1,17 @@
-"""Provide a Bot class that react to IRC's message and events."""
+"""
+Provide a Bot class that react to IRC's message and events.
+
+Classes
+-------
+.. autoclass:: Bot
+.. autoclass:: BotCommand
+
+Functions
+---------
+.. autofunction:: parse
+.. autofunction:: convert
+.. autofunction:: check_args
+"""
 
 import logging
 import time

src/irc_api/commands.py

@@ -1,4 +1,18 @@
-"""Defines the decorators for bot commands."""
+"""
+Defines the decorators for bot commands.
+
+Functions
+---------
+.. autofunction:: auto_help
+
+Decorators
+----------
+.. autodecorator:: command
+.. autodecorator:: channel
+.. autodecorator:: every
+.. autodecorator:: on
+.. autodecorator:: user
+"""
 from irc_api.bot import BotCommand
 
 def command(name: str, alias: tuple=(), desc: str=""):

src/irc_api/history.py

@@ -1,4 +1,10 @@
-"""Allow to save the messages history."""
+"""
+Allows to save the messages history.
+
+Classes
+-------
+.. autoclass:: History
+"""
 
 class History:
     """A custom queue to have access to the latest messages.

src/irc_api/irc.py

@@ -1,4 +1,10 @@
-"""Manage the IRC layer."""
+"""
+Manage the IRC layer.
+
+Classes
+-------
+.. autoclass:: IRC
+"""
 
 import logging
 import socket

src/irc_api/message.py

@@ -1,4 +1,10 @@
-"""Parse the raw incoming message into a Message instance."""
+"""
+Parse the raw incoming message into a Message instance.
+
+Classes
+-------
+.. autoclass:: Message
+"""
 
 import re