docs: add events

docs/api/events.rst

@@ -0,0 +1,65 @@
+.. currentmodule:: mafic
+
+Events
+======
+
+Classes
+-------
+
+.. attributetable:: WebSocketClosedEvent
+
+.. autoclass:: WebSocketClosedEvent
+
+.. attributetable:: TrackStartEvent
+
+.. autoclass:: TrackStartEvent
+
+.. attributetable:: TrackEndEvent
+
+.. autoclass:: TrackEndEvent
+
+.. attributetable:: TrackExceptionEvent
+
+.. autoclass:: TrackExceptionEvent
+
+.. attributetable:: TrackStuckEvent
+
+.. autoclass:: TrackStuckEvent
+
+Callbacks
+---------
+
+.. function:: on_websocket_closed()
+
+   Called when the websocket connection from Lavalink is closed to Discord.
+
+   :param event: The event that was dispatched.
+   :type event: :class:`WebSocketClosedEvent`
+
+.. function:: on_track_start()
+
+   Called when a track starts playing.
+
+   :param event: The event that was dispatched.
+   :type event: :class:`TrackStartEvent`
+
+.. function:: on_track_end()
+
+   Called when a track ends.
+
+   :param event: The event that was dispatched.
+   :type event: :class:`TrackEndEvent`
+
+.. function:: on_track_exception()
+
+   Called when a track throws an exception.
+
+   :param event: The event that was dispatched.
+   :type event: :class:`TrackExceptionEvent`
+
+.. function:: on_track_stuck()
+
+   Called when a track gets stuck.
+
+   :param event: The event that was dispatched.
+   :type event: :class:`TrackStuckEvent`

docs/api/index.rst

@@ -12,6 +12,7 @@ The full API reference for Mafic:
    stats
    ip
    player
+   events
    track-and-playlist
    filters
    errors-and-warnings