remove_object, TypeError, ValueError, Documentation (#163)

* Better exs (#154)

* Timedelta on period parameters (#157)

* Parameter updates
- Timedelta on period parameters,
- forced type annotations for some functions, classes

* ``.update`` methods to support channel checking (#159)

Updated ``.update`` methods to support new channel checking

* requirement (#160)

* Stronger Types (#162)

* Remove Message refactor, TypeError, ValueError

* Documentation

* Documentation

Author: davidhozic

docs/Makefile

@@ -19,7 +19,6 @@ help:
 
 html: Makefile
 	$(SPHINXBUILD) -b $@ source/ build/html
-	python3.8 scripts/add_tracking.py
 
 
 %: Makefile

docs/scripts/add_tracking.py

@@ -4,11 +4,7 @@
 import sys
 
 # Set current working directory to scripts folder
-for path, dirs, files in os.walk("./"):
-    for dir in dirs:
-        if dir == "scripts":
-            os.chdir(os.path.join(path, dir))
-            break
+os.chdir(os.path.dirname(__file__))
 
 
 sys.path.append(os.path.abspath("../../src"))
@@ -18,16 +14,18 @@
 """
 {function_name}
 --------------------------
-.. autofunction:: framework.{function_name}
+.. autofunction:: {module}.{function_name}
 """
 
 CLASS_TEMPLATE =\
 """
 
 {class_name}
-~~~~~~~~~~~~~~~~~~~~~~~~~
-.. autoclass:: framework.{class_name}
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+.. autoclass:: {class_path}
     :members:
+
+    {properties}
 """
 
 
@@ -37,9 +35,18 @@
     name, item = item
     if not name.startswith(("_", "Base")):
         if inspect.isfunction(item):
-            export_f += FUNCTION_TEMPLATE.format(function_name=item.__name__) + "\n"
+            export_f += FUNCTION_TEMPLATE.format(module= item.__module__, function_name=item.__name__) + "\n"
         elif inspect.isclass(item):
-            export_c += CLASS_TEMPLATE.format(class_name=item.__name__) + "\n"
+            # Fill properties 
+            properties = []
+            cls_path = f"{item.__module__}.{item.__name__}"
+            for name in dir(item):
+                attr = getattr(item, name)
+                if isinstance(attr, property):
+                    properties.append(f".. autoproperty:: {cls_path}.{name}")
+
+            export_c += CLASS_TEMPLATE.format(class_name=item.__name__, class_path=cls_path, properties="\n\n    ".join(properties)) + "\n"
+            
 
 
 with open("__autodoc_export_funct.rst", "w") as f:

docs/scripts/generate_autodoc.py

@@ -6,23 +6,22 @@
 
 
 # Set current working directory to scripts folder
-for path, dirs, files in os.walk("./"):
-    for dir in dirs:
-        if dir == "scripts":
-            os.chdir(os.path.join(path, dir))
-            break
+os.chdir(os.path.dirname(__file__))
 
 
 EXCEPTION_TEMPLATE =\
 """
-| {error_name}| {error_code}| {error_message}|
-+----------------------------------------+------+----------------------------------------------------------------------------------------------------------------------------+"""
+    {error_name}:
+        Value: {error_code}
+
+        Info: {error_message}
+"""
+# """
+# | {error_name}| {error_code}| {error_message}|
+# +----------------------------------------+------+----------------------------------------------------------------------------------------------------------------------------+"""
 
 
-export_e = """\
-+----------------------------------------+------+----------------------------------------------------------------------------------------------------------------------------+
-|     Name                               | Num  | Description                                                                                                                |
-+========================================+======+============================================================================================================================+"""
+export_e = ".. glossary::\n"
 fdata = ""
 with open("../../src/framework/exceptions.py", "r") as f:
     fdata += f.read()
@@ -33,9 +32,7 @@
     name = re.search(r"[A-z]+", exc).group(0)
     value = re.search(r"[0-9]+", exc).group(0)    
     description = re.search(r"(?<=#:).+", exc).group(0).strip()
-    export_e += EXCEPTION_TEMPLATE.format(error_name=name + "".join(' ' for i in range(39-len(name))), error_code=value + "".join(' ' for i in range(5-len(value))), error_message=description + "".join(' ' for i in range(123-len(description))))
-
-export_e += ""
+    export_e += EXCEPTION_TEMPLATE.format(error_name=name, error_code=value, error_message=description)
 
 
 with open("__autodoc_export_exceptions.rst", "w") as f:

docs/scripts/generate_error_codes.py

@@ -12,11 +12,11 @@ v2.1
 - ``timedelta`` object on ``start_period/end_period`` parameters
 - Replaced ``start_now`` with ``start_in`` parameter, deprecated use of bool value
 - :class:`framework.TextMESSAGE` and :class:`framework.VoiceMESSAGE` now check if the given channels are actually inside the guild
-- Fixed message slippage in case of slow Discord API calls or rate limit
+- Time slippage correction:
 
-.. figure:: images/changelog_2_1_slippage_fix.png
-    
-    Fixed message slippage in case of slow Discord API calls or rate limit
+.. figure:: images/changelog_2_1_slippage_fix.png    
+
+    Time slippage correction
 
 
 v2.0