Start of exception docs

Author: EvieePy

docs/_extensions/exc_hierarchy.py

@@ -0,0 +1,28 @@
+from docutils.parsers.rst import Directive
+from docutils.parsers.rst import states, directives
+from docutils.parsers.rst.roles import set_classes
+from docutils import nodes
+from sphinx.locale import _
+
+class exception_hierarchy(nodes.General, nodes.Element):
+    pass
+
+def visit_exception_hierarchy_node(self, node):
+    self.body.append(self.starttag(node, 'div', CLASS='exception-hierarchy-content'))
+
+def depart_exception_hierarchy_node(self, node):
+    self.body.append('</div>\n')
+
+class ExceptionHierarchyDirective(Directive):
+    has_content = True
+
+    def run(self):
+        self.assert_has_content()
+        node = exception_hierarchy('\n'.join(self.content))
+        self.state.nested_parse(self.content, self.content_offset, node)
+        return [node]
+
+def setup(app):
+    app.add_node(exception_hierarchy, html=(visit_exception_hierarchy_node, depart_exception_hierarchy_node))
+    app.add_directive('exception_hierarchy', ExceptionHierarchyDirective)
+    return {'parallel_read_safe': True}

docs/conf.py

@@ -53,6 +53,7 @@
     "sphinxcontrib_trio",
     "sphinx_wagtail_theme",
     "aiter",
+    "exc_hierarchy"
 ]
 
 # Add any paths that contain templates here, relative to this directory.

docs/index.rst

@@ -63,6 +63,7 @@ References
    references/events
    references/user
    references/eventsub_subscriptions
+   references/exceptions
 
 .. toctree::
    :maxdepth: 1

docs/references/exceptions.rst

@@ -0,0 +1,23 @@
+.. currentmodule:: twitchio
+
+
+Exceptions
+----------
+
+.. autoclass:: twitchio.TwitchioException
+
+.. autoclass:: twitchio.HTTPException
+    :members:
+
+.. autoclass:: twitchio.InvalidTokenException
+    :members:
+
+
+Exception Hierarchy
+~~~~~~~~~~~~~~~~~~~
+
+.. exception_hierarchy::
+
+    - :exc:`TwitchioException`
+         - :exc:`HTTPException`
+             - :exc:`InvalidTokenException`

twitchio/exceptions.py

@@ -27,7 +27,13 @@
 from typing import TYPE_CHECKING, Any
 
 
-__all__ = ("HTTPException", "MessageRejectedError", "TwitchioException", "WebsocketConnectionException")
+__all__ = (
+    "HTTPException",
+    "MessageRejectedError",
+    "TwitchioException",
+    "WebsocketConnectionException",
+    "InvalidTokenException",
+)
 
 
 if TYPE_CHECKING: