Finish helix docs for sphinx

Author: chillymosh

docs/references/models.rst

@@ -203,5 +203,189 @@ Models
     :members:
 
 
+.. attributetable:: twitchio.Clip
+
+.. autoclass:: twitchio.Clip
+    :members:
+
+
+.. attributetable:: twitchio.Entitlement
+
+.. autoclass:: twitchio.Entitlement
+    :members:
+
+
+.. attributetable:: twitchio.EntitlementStatus
+
+.. autoclass:: twitchio.EntitlementStatus
+    :members:
+
+.. attributetable:: twitchio.Game
+
+.. autoclass:: twitchio.Game
+    :members:
+
+.. attributetable:: twitchio.Goal
+
+.. autoclass:: twitchio.Goal
+    :members:
+
+.. attributetable:: twitchio.HypeTrainEvent
+
+.. autoclass:: twitchio.HypeTrainEvent
+    :members:
+
+.. attributetable:: twitchio.HypeTrainContribution
+
+.. autoclass:: twitchio.HypeTrainContribution
+    :members:
+
+.. attributetable:: twitchio.AutoModStatus
+
+.. autoclass:: twitchio.AutoModStatus
+    :members:
+
+.. attributetable:: twitchio.AutomodCheckMessage
+
+.. autoclass:: twitchio.AutomodCheckMessage
+    :members:
+
+.. attributetable:: twitchio.AutomodSettings
+
+.. autoclass:: twitchio.AutomodSettings
+    :members:
+
+.. attributetable:: twitchio.BannedUser
+
+.. autoclass:: twitchio.BannedUser
+    :members:
+
+.. attributetable:: twitchio.Ban
+
+.. autoclass:: twitchio.Ban
+    :members:
+
+.. attributetable:: twitchio.Timeout
+
+.. autoclass:: twitchio.Timeout
+    :members:
+
+.. attributetable:: twitchio.UnbanRequest
+
+.. autoclass:: twitchio.UnbanRequest
+    :members:
+
+.. attributetable:: twitchio.BlockedTerm
+
+.. autoclass:: twitchio.BlockedTerm
+    :members:
+
+.. attributetable:: twitchio.ShieldModeStatus
+
+.. autoclass:: twitchio.ShieldModeStatus
+    :members:
+
+.. attributetable:: twitchio.Warning
+
+.. autoclass:: twitchio.Warning
+    :members:
+
+.. attributetable:: twitchio.Poll
+
+.. autoclass:: twitchio.Poll
+    :members:
+
+.. attributetable:: twitchio.PollChoice
+
+.. autoclass:: twitchio.PollChoice
+    :members:
+
+.. attributetable:: twitchio.Prediction
+
+.. autoclass:: twitchio.Prediction
+    :members:
+
+.. attributetable:: twitchio.PredictionOutcome
+
+.. autoclass:: twitchio.PredictionOutcome
+    :members:
+
+.. attributetable:: twitchio.Predictor
+
+.. autoclass:: twitchio.Predictor
+    :members:
+
+
+.. attributetable:: twitchio.Raid
+
+.. autoclass:: twitchio.Raid
+    :members:
+
+.. attributetable:: twitchio.Schedule
+
+.. autoclass:: twitchio.Schedule
+    :members:
+
+.. attributetable:: twitchio.ScheduleSegment
+
+.. autoclass:: twitchio.ScheduleSegment
+    :members:
+
+.. attributetable:: twitchio.ScheduleCategory
+
+.. autoclass:: twitchio.ScheduleCategory
+    :members:
+
+.. attributetable:: twitchio.ScheduleVacation
+
+.. autoclass:: twitchio.ScheduleVacation
+    :members:
+
+.. attributetable:: twitchio.SearchChannel
+
+.. autoclass:: twitchio.SearchChannel
+    :members:
+
+.. attributetable:: twitchio.Stream
+
+.. autoclass:: twitchio.Stream
+    :members:
+
+.. attributetable:: twitchio.StreamMarker
+
+.. autoclass:: twitchio.StreamMarker
+    :members:
+
+.. attributetable:: twitchio.VideoMarkers
+
+.. autoclass:: twitchio.VideoMarkers
+    :members:
+
+.. attributetable:: twitchio.UserSubscription
+
+.. autoclass:: twitchio.UserSubscription
+    :members:
+
+.. attributetable:: twitchio.BroadcasterSubscription
+
+.. autoclass:: twitchio.BroadcasterSubscription
+    :members:
+
+.. attributetable:: twitchio.BroadcasterSubscriptions
+
+.. autoclass:: twitchio.BroadcasterSubscriptions
+    :members:
+
+.. attributetable:: twitchio.Team
+
+.. autoclass:: twitchio.Team
+    :members:
+
+.. attributetable:: twitchio.ChannelTeam
+
+.. autoclass:: twitchio.ChannelTeam
+    :members:
+
+
 
 

twitchio/models/chat.py

@@ -524,10 +524,14 @@ class ChatSettings:
     non_moderator_chat_delay: bool
         A Boolean value that determines whether the broadcaster adds a short delay before chat messages appear in the chat room.
         This gives chat moderators and bots a chance to remove them before viewers can see the message.
-        See the non_moderator_chat_delay_duration field for the length of the delay. Is True if the broadcaster applies a delay; otherwise, False.
+        See the ``non_moderator_chat_delay_duration`` field for the length of the delay.
+
+        Is True if the broadcaster applies a delay; otherwise, False.
+
         The response includes this field only if the request specifies a user access token that includes the ``moderator:read:chat_settings`` scope and the user in the moderator_id query parameter is one of the broadcaster's moderators.
     non_moderator_chat_delay_duration: int | None
         The amount of time, in seconds, that messages are delayed before appearing in chat. Is None if non_moderator_chat_delay is False.
+
         The response includes this field only if the request specifies a user access token that includes the ``moderator:read:chat_settings scope`` and the user in the moderator_id query parameter is one of the broadcaster's moderators.
     """
 

twitchio/models/clips.py

@@ -50,8 +50,7 @@
 
 
 class Clip:
-    """
-    Represents a Twitch Clip
+    """Represents a Twitch Clip
 
     Attributes
     -----------
@@ -78,7 +77,7 @@ class Clip:
     created_at: datetime.datetime
         When the clip was created.
     thumbnail: twitchio.Asset
-        The [`Asset`][twitchio.assets.Asset] that can be used to read or save the thumbnail associated with this Clip.
+        The :class:`~twitchio.Asset` that can be used to read or save the thumbnail associated with this Clip.
     is_featured: bool
         Indicates if the clip is featured or not.
     """
@@ -123,22 +122,22 @@ def __str__(self) -> str:
         return self.id
 
     async def fetch_game(self) -> Game:
-        """Fetches the [`Game`][twitchio.Game] associated with this Clip.
+        """Fetches the :class:`~twitchio.Game` associated with this Clip.
 
         Returns
         -------
-        twitchio.Game
+        Game
             The game associated with this Clip.
         """
         payload: GamesResponse = await self._http.get_games(ids=[self.game_id])
         return Game(payload["data"][0], http=self._http)
 
     async def fetch_video(self) -> Video | None:
-        """Fetches the [`Video`][twitchio.Video] associated with this clip, if it can be found.
+        """Fetches the :class:`~twitchio.Video` associated with this clip, if it can be found.
 
         Returns
         -------
-        twitchio.Video
+        Video
             The video associated with this Clip.
         None
             The video was not found.

twitchio/models/entitlements.py

@@ -46,8 +46,7 @@
 
 
 class Entitlement:
-    """
-    Represents a drops entitlement.
+    """Represents a drops entitlement.
 
     Attributes
     -----------
@@ -57,7 +56,7 @@ class Entitlement:
         An ID that identifies the benefit (reward).
     timestamp: datetime.datetime
         Datetime of when the entitlement was granted.
-    user: twitchio.PartialUser
+    user: PartialUser
         PartialUser of who was granted the entitlement.
     game_id: str
         An ID that identifies the game the user was playing when the reward was entitled.
@@ -95,19 +94,44 @@ def __str__(self) -> str:
         return self.id
 
     async def fetch_game(self) -> Game:
-        """
-        Fetches the [`Game`][twitchio.Game] associated with this drop entitlement.
+        """Fetches the :class:`~twitchio.Game` associated with this drop entitlement.
 
         Returns
         -------
-        twitchio.Game
+        Game
             The game associated with this drop entitlement.
         """
         payload: GamesResponse = await self._http.get_games(ids=[self.game_id])
         return Game(payload["data"][0], http=self._http)
 
 
 class EntitlementStatus:
+    """The status of entitlements after an update.
+
+    Attributes
+    -----------
+    status: Literal["INVALID_ID", "NOT_FOUND", "SUCCESS", "UNAUTHORIZED", "UPDATE_FAILED"]
+        Indicates whether the status of the entitlements in the ids field were successfully updated.
+
+        +----------------+----------------------------------------------------------------------------------------------------+
+        | Status         | Description                                                                                        |
+        +================+====================================================================================================+
+        | INVALID_ID     | The entitlement IDs in the ids field are not valid.                                                |
+        +----------------+----------------------------------------------------------------------------------------------------+
+        | NOT_FOUND      | The entitlement IDs in the ids field were not found.                                               |
+        +----------------+----------------------------------------------------------------------------------------------------+
+        | SUCCESS        | The status of the entitlements in the ids field were successfully updated.                         |
+        +----------------+----------------------------------------------------------------------------------------------------+
+        | UNAUTHORIZED   | The user or organization identified by the user access token is not authorized to update the       |
+        |                | entitlements.                                                                                      |
+        +----------------+----------------------------------------------------------------------------------------------------+
+        | UPDATE_FAILED  | The update failed. These are considered transient errors and the request should be retried later.  |
+        +----------------+----------------------------------------------------------------------------------------------------+
+
+    ids: list[str]
+        The list of entitlement ids that the status in the status field applies to.
+    """
+
     def __init__(self, data: UpdateDropsEntitlementsResponseData) -> None:
         self.status: Literal["INVALID_ID", "NOT_FOUND", "SUCCESS", "UNAUTHORIZED", "UPDATE_FAILED"] = data["status"]
         self.ids: list[str] = data["ids"]

twitchio/models/games.py

@@ -38,22 +38,25 @@
 
 
 class Game:
-    """
-    Represents a Game on Twitch.
+    """Represents a Game on Twitch.
 
-    You can retrieve a game by its ID, name or IGDB ID using the [`Client.fetch_game`][twitchio.Client.fetch_game]
-    method or the various `.fetch_game()` methods of other models.
+    You can retrieve a game by its ID, name or IGDB ID using the :meth:`~twitchio.Client.fetch_games`
+    method or the various ``.fetch_game()`` methods of other models.
 
-    To fetch a list of games, see: [`Client.fetch_games`][twitchio.Client.fetch_games]
+    To fetch a list of games, see: :meth:`~twitchio.Client.fetch_games`
 
     Supported Operations
     --------------------
 
-    | Operation   | Usage(s)                                 | Description                                        |
-    |-----------  |------------------------------------------|----------------------------------------------------|
-    | `__str__`   | `str(game)`, `f"{game}"`                 | Returns the games name.                            |
-    | `__repr__`  | `repr(game)`, `f"{game!r}"`              | Returns the games official representation.         |
-    | `__eq__`    | `game == game2`, `game != game2`         | Checks if two games are equal.                     |
+    +-------------+----------------------------------+----------------------------------------------------+
+    | Operation   | Usage(s)                        | Description                                         |
+    +=============+==================================+====================================================+
+    | __str__     | str(game), f"{game}"             | Returns the games name.                            |
+    +-------------+----------------------------------+----------------------------------------------------+
+    | __repr__    | repr(game), f"{game!r}"          | Returns the games official representation.         |
+    +-------------+----------------------------------+----------------------------------------------------+
+    | __eq__      | game == game2, game != game2     | Checks if two games are equal.                     |
+    +-------------+----------------------------------+----------------------------------------------------+
 
 
     Attributes
@@ -63,9 +66,9 @@ class Game:
     name: str
         The name of the game.
     box_art: Asset
-        The box art of the game as an [`Asset`][twitchio.Asset].
+        The box art of the game as an :class:`~twitchio.Assets`.
     igdb_id: str | None
-        The IGDB ID of the game. If this is not available to Twitch it will be `None`.
+        The IGDB ID of the game. If this is not available to Twitch it will be ``None``.
     """
 
     __slots__ = ("id", "name", "box_art", "igdb_id")