Reviewing documentation

docs/bot.rst

@@ -4,6 +4,11 @@
 Bot
 ---
 .. automodule:: irc_api.bot
-    :members:
-    :undoc-members:
-    :show-inheritance:
+	:ignore-module-all:
+
+	.. autoclass:: Bot
+	.. autoclass:: BotCommand
+	.. autoexception:: WrongArg
+	.. autofunction:: check_args
+	.. autofunction:: convert	
+	.. autofunction:: parse

docs/commands.rst

@@ -4,7 +4,12 @@
 Commands
 --------
 .. automodule:: irc_api.commands
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    :ignore-module-all:
+    
+    .. autodecorator:: command
+    .. autodecorator:: channel
+    .. autodecorator:: every
+    .. autodecorator:: on
+    .. autodecorator:: user
+    .. autofunction:: auto_help
 

docs/history.rst

@@ -4,6 +4,6 @@
 History
 -------
 .. automodule:: irc_api.history
-    :members:
-    :undoc-members:
-    :show-inheritance:
+	:ignore-module-all:
+	
+	.. autoclass:: History

docs/irc.rst

@@ -4,6 +4,7 @@
 IRC
 ---
 .. automodule:: irc_api.irc
-    :members:
-    :undoc-members:
-    :show-inheritance:
+   	:ignore-module-all:
+   	
+   	.. autoclass:: IRC
+

docs/message.rst

@@ -4,6 +4,6 @@
 Message
 -------
 .. automodule:: irc_api.message
-    :members:
-    :undoc-members:
-    :show-inheritance:
+    :ignore-module-all:
+    
+    .. autoclass:: Message

docs/requirements.txt

@@ -1,4 +1,3 @@
-
 sphinx
 sphinx-autodocgen
 sphinx-rtd-theme

src/irc_api/__init__.py

@@ -1 +1 @@
-__version__ = "1.0.6"
+__version__ = "1.0.7"

src/irc_api/bot.py

@@ -34,18 +34,25 @@ class Bot:
 
     Methods
     -------
-    start : NoneType, public
-        Runs the bot and connects it to IRC server.
-    send : NoneType, public
-        Send a message on the IRC server.
-    add_command : NoneType, public
-        Add a single command to the bot.
-    add_commands : NoneType, public
-        Allow to add a list of command to the bot.
-    add_commands_module : NoneType, public
-        Allow to add a module of command to the bot.
-    remove_command : NoneType, public
-        Remove a command.
+    .. automethod:: __init__
+    .. automethod:: add_command
+    .. automethod:: add_commands
+    .. automethod:: add_commands_module
+    .. automethod:: remove_commands
+    .. automethod:: send
+    .. automethod:: start
+
+    Examples
+    --------
+    Assuming the module was imported as follow: ``from irc_api import api``
+    You can create a bot::
+
+        my_bot = api.Bot(
+                irc_params=(irc.exemple.com, 6697),
+                channels=["#general", "#bot-test"],
+                prefix="!",
+                cmnd_pack1, cmnd_pack2
+            )
     """
     def __init__(
             self,
@@ -72,18 +79,6 @@ class Bot:
             The message history of the bot. By default, the bot will remind 100 messages.
         *commands_module : optionnal
             Modules of commands that you can give to the bot at it's creation.
-
-        Examples
-        --------
-        Assuming the module was imported as follow: ``from irc_api import api``
-        You can create a bot::
-
-            my_bot = api.Bot(
-                    irc_params=(irc.exemple.com, 6697),
-                    channels=["#general", "#bot-test"],
-                    prefix="!",
-                    cmnd_pack1, cmnd_pack2
-                )
         """
         self.prefix = prefix
 
@@ -240,9 +235,9 @@ class BotCommand:
         The description of the BotCommand. By default, the function's docstring is used.
     cmnd_type : int, public
         The type of the command.
-        - if ``cmnd_type = 0``, the command is triggered on an event.
-        - if ``cmnd_type = 1``, the command is a named command.
-        - if ``cmnd_type = 2``, the command is a routine automatically triggered.
+        * if ``cmnd_type = 0``, the command is triggered on an event.
+        * if ``cmnd_type = 1``, the command is a named command.
+        * if ``cmnd_type = 2``, the command is a routine automatically triggered.
     bot : irc_api.bot.Bot, public
         The bot the command belongs to.
     """
@@ -261,9 +256,9 @@ class BotCommand:
             The description of the BotCommand. By default, the function's docstring is used.
         cmnd_type : int
             The type of the command.
-            - if ``cmnd_type = 0``, the command is triggered on an event.
-            - if ``cmnd_type = 1``, the command is a named command.
-            - if ``cmnd_type = 2``, the command is a routine automatically triggered.
+            * if ``cmnd_type = 0``, the command is triggered on an event.
+            * if ``cmnd_type = 1``, the command is a named command.
+            * if ``cmnd_type = 2``, the command is a routine automatically triggered.
         """
         self.name = name
         self.func = func

src/irc_api/history.py

@@ -12,19 +12,11 @@ class History:
 
     Methods
     -------
-    add : NoneType, public
-        Add an element to the History. If the History is full, the oldest message is deleted.
-    get : list, public
-        Returns the content of the History.
+    .. automethod:: add
+    .. automethod:: get
     """
     def __init__(self, limit: int):
-        """Initialize the History.
-        
-        Parameters
-        ----------
-        limit : int
-            The maximum number of messages the History's instance can handle.
-        """
+        """Constructor method."""
         self.__content = []
         if limit:
             self.__limit = limit
@@ -32,7 +24,7 @@ class History:
             self.__limit = 100
 
     def __len__(self):
-        """Returns the lenght of the History's instance."""
+        """Returns the length of the History's instance."""
         return len(self.__content)
 
     def add(self, elmnt):

src/irc_api/irc.py

@@ -25,20 +25,13 @@ class IRC:
 
     Methods
     -------
-    connection : NoneType, public
-        Starts the IRC layer and manage authentication.
-    send : NoneType, public
-        Sends a message to a given channel.
-    receive : Message, public
-        Receive a new raw message and return the processed message. 
-    join : NoneType, public
-        Allows to join a given channel.
-    waitfor : str, public
-        Wait for a raw message that matches the given condition.
+    .. automethod:: __init__
+    .. automethod:: connection
+    .. automethod:: join
+    .. automethod:: receive
+    .. automethod:: send
+    .. automethod:: waitfor
 
-    handle : NoneType, private
-        Handles the ping and store incoming messages into the inbox attribute.
-    
     """
     def __init__(self, host: str, port: int):
         """Initialize an IRC wrapper.