fix the docs

Author: doluk

coc/__init__.py

@@ -75,7 +75,10 @@
     TimeDelta,
     Label,
     WarLeague,
+    GoldPassSeason,
+    ChatLanguage
 )
+from .entry_logs import LogPaginator, ClanWarLog, RaidLog
 from .players import Player, ClanMember, RankedPlayer
 from .player_clan import PlayerClan
 from .spell import Spell
@@ -85,3 +88,4 @@
 from .war_members import ClanWarLeagueClanMember, ClanWarMember
 from .wars import ClanWar, ClanWarLogEntry, ClanWarLeagueGroup
 from . import utils
+from .raid import RaidLogEntry, RaidClan, RaidMember, RaidAttack, RaidDistrict

coc/hero.py

@@ -52,6 +52,9 @@ class Hero(DataContainer):
     village: str
         Either ``home`` or ``builderBase``, indicating which village this hero belongs to.
     """
+    __slots__ = ("id", "name", "range", "dps", "hitpoints", "ground_target", "speed", "upgrade_cost",
+                 "upgrade_time", "ability_time", "required_th_level", "regeneration_time", "level",
+                 "max_level", "village")
     name: str
     level: int
     max_level: int
@@ -140,6 +143,8 @@ class Pet(DataContainer):
     village: str
         Either ``home`` or ``builderBase``, indicating which village this pet belongs to.
     """
+    __slots__ = ("id", "name", "range", "dps", "ground_target", "hitpoints", "speed", "upgrade_cost",
+                 "upgrade_resource", "upgrade_time", "level", "max_level", "village")
     name: str
     level: int
     max_level: int

coc/raid.py

@@ -28,10 +28,6 @@
 from .miscmodels import Badge, Timestamp, try_enum
 from .utils import cached_property, correct_tag
 
-if TYPE_CHECKING:
-    # pylint: disable=cyclic-import
-    from .war_members import ClanWarMember  # noqa
-
 
 class RaidMember(BasePlayer):
     """Represents a Raid Member that the API returns.

coc/spell.py

@@ -47,6 +47,9 @@ class Spell(DataContainer):
     village: str
         Either ``home`` or ``builderBase``, indicating which village this spell belongs to.
     """
+    __slots__ = ("id", "name", "range", "upgrade_cost", "upgrade_resource", "upgrade_time",
+                 "training_cost", "training_resource", "training_time", "is_siege_machine", "level", "max_level",
+                 "village")
     name: str
     level: int
     max_level: int

coc/troop.py

@@ -37,13 +37,13 @@ class Troop(DataContainer):
     +----------------------------------+-------------------+
     |  :attr:`Troop.upgrade_resource`  | :class:`Resource` |
     +----------------------------------+-------------------+
-    |    :attr:`Troop.upgrade_time`    |   :class:`TimeDelta`   |
+    |    :attr:`Troop.upgrade_time`    | :class:`TimeDelta`|
     +----------------------------------+-------------------+
     |   :attr:`Troop.training_cost`    |        int        |
     +----------------------------------+-------------------+
     | :attr:`Troop.training_resource`  | :class:`Resource` |
     +----------------------------------+-------------------+
-    |   :attr:`Troop.training_time`    |   :class:`TimeDelta`   |
+    |   :attr:`Troop.training_time`    |:class:`TimeDelta` |
     +----------------------------------+-------------------+
     |  :attr:`Troop.is_elixir_troop`   |   :class:`bool`   |
     +----------------------------------+-------------------+
@@ -53,9 +53,9 @@ class Troop(DataContainer):
     +----------------------------------+-------------------+
     |   :attr:`Troop.is_super_troop`   |   :class:`bool`   |
     +----------------------------------+-------------------+
-    |      :attr:`Troop.cooldown`      |   :class:`TimeDelta`   |
+    |      :attr:`Troop.cooldown`      | :class:`TimeDelta`|
     +----------------------------------+-------------------+
-    |      :attr:`Troop.duration`      |   :class:`TimeDelta`   |
+    |      :attr:`Troop.duration`      | :class:`TimeDelta`|
     +----------------------------------+-------------------+
     | :attr:`Troop.min_original_level` |        int        |
     +----------------------------------+-------------------+
@@ -127,6 +127,9 @@ class Troop(DataContainer):
     village: str
         Either ``home`` or ``builderBase``, indicating which village this troop belongs to.
     """
+    __slots__ = ("id", "name", "range", "lab_level", "dps", "hitpoints", "ground_traget", "speed", "upgrade_cost",
+                 "upgrade_resource", "upgrade_time", "training_cost", "training_resource", "training_time",
+                 "cooldown", "duration", "min_original_level", "original_troop", "level", "max_level", "village")
     name: str
     level: int
     max_level: int

docs/code_overview/event.rst

@@ -242,6 +242,7 @@ A few points to note:
 - Tags will be automatically corrected via the :meth:`coc.correct_tag` function.
 
 - **Every tag** that is added to the client will be sent to **every callback for that event group**.
+
 This makes for a much simpler internal design.
 
 

docs/code_overview/game_data.rst

@@ -1,5 +1,6 @@
 .. currentmodule:: coc
 .. _game_data:
+
 Game Data
 =========
 The following provides a detailed how-to for use of static game data that is loaded into coc.py.
@@ -22,6 +23,7 @@ Additionally, speed and memory consumption has been prioritised and optimised wh
 
 
 .. _initialising_game_data:
+
 Initialising the Client
 -----------------------
 
@@ -82,6 +84,7 @@ Although all efforts have been made to minimise overheads, some may prefer to on
 
 
 .. _loading_game_data:
+
 Loading Game Data Manually
 --------------------------
 
@@ -125,6 +128,7 @@ won't have metadata loaded. This is easy to fix, with the :meth:`Player.load_gam
 
 
 .. _initiated_v_uninitiated:
+
 Initiated vs Uninitiated Objects
 --------------------------------
 
@@ -138,6 +142,7 @@ with attributes.
 
 
 .. _initiated_objects:
+
 Initiated Objects
 ~~~~~~~~~~~~~~~~~
 
@@ -197,6 +202,7 @@ Alternatively, you could use :meth:`Client.get_troop` and use the unititiated ob
 
 
 .. _uninitiated_objects:
+
 Uninitiated Objects
 ~~~~~~~~~~~~~~~~~~~
 

docs/code_overview/models.rst

@@ -27,6 +27,13 @@ Player Clan
     :private-members:
     :inherited-members:
 
+Raid Clan
+^^^^^^^^^
+.. autoclass:: RaidClan()
+    :members:
+    :private-members:
+    :inherited-members:
+
 Ranked Clan
 ^^^^^^^^^^^
 .. autoclass:: RankedClan()
@@ -74,7 +81,7 @@ Clan Member
     :inherited-members:
 
 Ranked Player
-^^^^^^^^^^^
+^^^^^^^^^^^^^
 .. autoclass:: RankedPlayer()
     :members:
     :private-members:
@@ -94,6 +101,13 @@ Clan War Member
     :private-members:
     :inherited-members:
 
+Raid Member
+^^^^^^^^^^^
+.. autoclass:: RaidMember()
+    :members:
+    :private-members:
+    :inherited-members:
+
 Player
 ^^^^^^
 .. autoclass:: Player()
@@ -135,6 +149,30 @@ WarAttack
     :private-members:
 
 
+Raids
+~~~~~~
+
+Raid Log Entry
+^^^^^^^^^^^^^^
+.. autoclass:: RaidLogEntry()
+    :members:
+    :private-members:
+    :inherited-members:
+
+Raid District
+^^^^^^^^^^^^^
+.. autoclass:: RaidDistrict()
+    :members:
+    :private-members:
+    :inherited-members:
+
+Raid Attack
+~~~~~~~~~~~~
+.. autoclass:: RaidAttack()
+    :members:
+    :private-members:
+
+
 Achievement
 ~~~~~~~~~~~~
 
@@ -152,23 +190,27 @@ Troop
 
 Hero
 ~~~~~
-
 .. autoclass:: Hero()
     :members:
     :private-members:
 
 
+Pet
+~~~~
+.. autoclass:: Pet()
+    :members:
+    :private-members:
+
+
 Spell
 ~~~~~~
-
 .. autoclass:: Spell()
     :members:
     :private-members:
 
 
 Location
 ~~~~~~~~~
-
 .. autoclass:: Location()
     :members:
     :private-members:
@@ -230,6 +272,13 @@ War League
     :members:
     :private-members:
 
+Gold pass season
+~~~~~~~~~~~~~~~~~
+.. autoclass:: GoldPassSeason()
+    :members:
+    :private-members:
+    :inherited-members:
+
 Enumerations
 ~~~~~~~~~~~~
 

docs/discord-links/api-reference.rst

@@ -1,4 +1,4 @@
-.. current-module:: coc
+.. currentmodule:: coc
 
 API Reference
 =============

docs/discord-links/discord-links-examples.rst

@@ -1,4 +1,4 @@
-.. current-module:: coc
+.. currentmodule:: coc
 
 Examples
 ========