Skip to content

Commit d2f479b

Browse files
Galarzaa90Galarzaa90
committed
Updated documentation
1 parent b6a3da4 commit d2f479b

File tree

2 files changed

+91
-69
lines changed

2 files changed

+91
-69
lines changed

‎docs/api.rst‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -712,6 +712,25 @@ CreatureEntry
712712
:members:
713713
:inherited-members:
714714

715+
BoostableBosses
716+
----------------
717+
.. autoclass:: BoostableBosses
718+
:members:
719+
:inherited-members:
720+
721+
BoostedCreatures
722+
----------------
723+
.. autoclass:: BoostedCreatures
724+
:members:
725+
:inherited-members:
726+
727+
BossEntry
728+
-------------
729+
.. autoclass:: BossEntry
730+
:members:
731+
:inherited-members:
732+
733+
715734
SpellsSection
716735
-------------
717736
.. autoclass:: SpellsSection

‎docs/intro.rst‎

Lines changed: 72 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -76,75 +76,78 @@ On the other hand, using the built-in asynchronous client you can do the fetchin
7676
Supported Sections
7777
==================
7878

79-
+----------------------------------+--------------------------------------------+---------------------------------------------+
80-
| Section | Parsing | Fetching |
81-
+==================================+============================================+=============================================+
82-
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
83-
+----------------------------------+--------------------------------------------+---------------------------------------------+
84-
| `Character Bazaar`_ (Current) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_current_auctions` |
85-
+----------------------------------+--------------------------------------------+---------------------------------------------+
86-
| `Character Bazaar`_ (History) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_auction_history` |
87-
+----------------------------------+--------------------------------------------+---------------------------------------------+
88-
| `Character Bazaar`_ (Detail) | :meth:`Auction.from_content` | :meth:`Client.fetch_auction` |
89-
+----------------------------------+--------------------------------------------+---------------------------------------------+
90-
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
91-
+----------------------------------+--------------------------------------------+---------------------------------------------+
92-
| `CM Post Archive`_ | :meth:`CMPostArchive.from_content` | :meth:`Client.fetch_cm_post_archive` |
93-
+----------------------------------+--------------------------------------------+---------------------------------------------+
94-
| `Creature Library`_ (List) | :meth:`CreaturesSection.from_content` | :meth:`Client.fetch_library_creatures` |
95-
+----------------------------------+--------------------------------------------+---------------------------------------------+
96-
| `Creature Library`_ (Individual) | :meth:`Creature.from_content` | :meth:`Client.fetch_creature` |
97-
+----------------------------------+--------------------------------------------+---------------------------------------------+
98-
| `Event Schedule`_ | :meth:`EventSchedule.from_content` | :meth:`Client.fetch_event_schedule` |
99-
+----------------------------------+--------------------------------------------+---------------------------------------------+
100-
| Guilds_ (Individual) | :meth:`Guild.from_content` | :meth:`Client.fetch_guild` |
101-
+----------------------------------+--------------------------------------------+---------------------------------------------+
102-
| Guilds_ (List) | :meth:`GuildsSection.from_content` | :meth:`Client.fetch_world_guilds` |
103-
+----------------------------------+--------------------------------------------+---------------------------------------------+
104-
| Guilds_ (Wars) | :meth:`GuildWars.from_content` | :meth:`Client.fetch_guild_wars` |
105-
+----------------------------------+--------------------------------------------+---------------------------------------------+
106-
| Forums_ (Section) | :meth:`BoardEntry.list_from_content` | :meth:`Client.fetch_forum_world_boards` |
107-
| | | :meth:`Client.fetch_forum_trade_boards` |
108-
| | | :meth:`Client.fetch_forum_community_boards` |
109-
| | | :meth:`Client.fetch_forum_support_boards` |
110-
+----------------------------------+--------------------------------------------+---------------------------------------------+
111-
| Forums_ (Board) | :meth:`ForumBoard.from_content` | :meth:`Client.fetch_forum_board` |
112-
+----------------------------------+--------------------------------------------+---------------------------------------------+
113-
| Forums_ (Announcement) | :meth:`ForumAnnouncement.from_content` | :meth:`Client.fetch_forum_announcement` |
114-
+----------------------------------+--------------------------------------------+---------------------------------------------+
115-
| Forums_ (Thread) | :meth:`ForumThread.from_content` | :meth:`Client.fetch_forum_thread` |
116-
+----------------------------------+--------------------------------------------+---------------------------------------------+
117-
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
118-
+----------------------------------+--------------------------------------------+---------------------------------------------+
119-
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
120-
+----------------------------------+--------------------------------------------+---------------------------------------------+
121-
| Houses_ (Individual) | :meth:`House.from_content` | :meth:`Client.fetch_house` |
122-
+----------------------------------+--------------------------------------------+---------------------------------------------+
123-
| Houses_ (List) | :meth:`HousesSection.from_content` | :meth:`Client.fetch_world_houses` |
124-
+----------------------------------+--------------------------------------------+---------------------------------------------+
125-
| `Kill Statistics`_ (List) | :meth:`KillStatistics.from_content` | :meth:`Client.fetch_kill_statistics` |
126-
+----------------------------------+--------------------------------------------+---------------------------------------------+
127-
| Leaderboards_ | :meth:`Leaderboard.from_content` | :meth:`Client.fetch_leaderboard` |
128-
+----------------------------------+--------------------------------------------+---------------------------------------------+
129-
| News_ (Individual) | :meth:`News.from_content` | :meth:`Client.fetch_news` |
130-
+----------------------------------+--------------------------------------------+---------------------------------------------+
131-
| News_ (List) | :meth:`NewsArchive.from_content` | :meth:`Client.fetch_news_archive` |
132-
| | | :meth:`Client.fetch_recent_news` |
133-
+----------------------------------+--------------------------------------------+---------------------------------------------+
134-
| `Spell Library`_ (List) | :meth:`SpellsSection.from_content` | :meth:`Client.fetch_spells` |
135-
+----------------------------------+--------------------------------------------+---------------------------------------------+
136-
| `Spell Library`_ (Individual) | :meth:`Spell.from_content` | :meth:`Client.fetch_spell` |
137-
+----------------------------------+--------------------------------------------+---------------------------------------------+
138-
| Tournaments_ | :meth:`Tournament.from_content` | :meth:`Client.fetch_tournament` |
139-
+----------------------------------+--------------------------------------------+---------------------------------------------+
140-
| `Tournament Leaderboards`_ | :meth:`TournamentLeaderboard.from_content` | :meth:`Client.fetch_tournament_leaderboard` |
141-
+----------------------------------+--------------------------------------------+---------------------------------------------+
142-
| Worlds_ (Individual) | :meth:`World.from_content` | :meth:`Client.fetch_world` |
143-
+----------------------------------+--------------------------------------------+---------------------------------------------+
144-
| Worlds_ (List) | :meth:`WorldOverview.from_content` | :meth:`Client.fetch_world_list` |
145-
+----------------------------------+--------------------------------------------+---------------------------------------------+
146-
147-
79+
+----------------------------------+--------------------------------------------+----------------------------------------------+
80+
| Section | Parsing | Fetching |
81+
+==================================+============================================+==============================================+
82+
| `Boostable Bosses`_ (List) | :meth:`BoostableBosses.from_content` | :meth:`Client.fetch_library_bosses` |
83+
+----------------------------------+--------------------------------------------+----------------------------------------------+
84+
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
85+
+----------------------------------+--------------------------------------------+----------------------------------------------+
86+
| `Character Bazaar`_ (Current) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_current_auctions` |
87+
+----------------------------------+--------------------------------------------+----------------------------------------------+
88+
| `Character Bazaar`_ (History) | :meth:`CharacterBazaar.from_content` | :meth:`Client.fetch_auction_history` |
89+
+----------------------------------+--------------------------------------------+----------------------------------------------+
90+
| `Character Bazaar`_ (Detail) | :meth:`Auction.from_content` | :meth:`Client.fetch_auction` |
91+
+----------------------------------+--------------------------------------------+----------------------------------------------+
92+
| Characters_ | :meth:`Character.from_content` | :meth:`Client.fetch_character` |
93+
+----------------------------------+--------------------------------------------+----------------------------------------------+
94+
| `CM Post Archive`_ | :meth:`CMPostArchive.from_content` | :meth:`Client.fetch_cm_post_archive` |
95+
+----------------------------------+--------------------------------------------+----------------------------------------------+
96+
| `Creature Library`_ (List) | :meth:`CreaturesSection.from_content` | :meth:`Client.fetch_library_creatures` |
97+
+----------------------------------+--------------------------------------------+----------------------------------------------+
98+
| `Creature Library`_ (Individual) | :meth:`Creature.from_content` | :meth:`Client.fetch_creature` |
99+
+----------------------------------+--------------------------------------------+----------------------------------------------+
100+
| `Event Schedule`_ | :meth:`EventSchedule.from_content` | :meth:`Client.fetch_event_schedule` |
101+
+----------------------------------+--------------------------------------------+----------------------------------------------+
102+
| Guilds_ (Individual) | :meth:`Guild.from_content` | :meth:`Client.fetch_guild` |
103+
+----------------------------------+--------------------------------------------+----------------------------------------------+
104+
| Guilds_ (List) | :meth:`GuildsSection.from_content` | :meth:`Client.fetch_world_guilds` |
105+
+----------------------------------+--------------------------------------------+----------------------------------------------+
106+
| Guilds_ (Wars) | :meth:`GuildWars.from_content` | :meth:`Client.fetch_guild_wars` |
107+
+----------------------------------+--------------------------------------------+----------------------------------------------+
108+
|| Forums_ (Section) || :meth:`BoardEntry.list_from_content` || :meth:`Client.fetch_forum_world_boards` |
109+
|| || || :meth:`Client.fetch_forum_trade_boards` |
110+
|| || || :meth:`Client.fetch_forum_community_boards` |
111+
|| || || :meth:`Client.fetch_forum_support_boards` |
112+
+----------------------------------+--------------------------------------------+----------------------------------------------+
113+
| Forums_ (Board) | :meth:`ForumBoard.from_content` | :meth:`Client.fetch_forum_board` |
114+
+----------------------------------+--------------------------------------------+----------------------------------------------+
115+
| Forums_ (Announcement) | :meth:`ForumAnnouncement.from_content` | :meth:`Client.fetch_forum_announcement` |
116+
+----------------------------------+--------------------------------------------+----------------------------------------------+
117+
| Forums_ (Thread) | :meth:`ForumThread.from_content` | :meth:`Client.fetch_forum_thread` |
118+
+----------------------------------+--------------------------------------------+----------------------------------------------+
119+
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
120+
+----------------------------------+--------------------------------------------+----------------------------------------------+
121+
| Highscores_ | :meth:`Highscores.from_content` | :meth:`Client.fetch_highscores_page` |
122+
+----------------------------------+--------------------------------------------+----------------------------------------------+
123+
| Houses_ (Individual) | :meth:`House.from_content` | :meth:`Client.fetch_house` |
124+
+----------------------------------+--------------------------------------------+----------------------------------------------+
125+
| Houses_ (List) | :meth:`HousesSection.from_content` | :meth:`Client.fetch_world_houses` |
126+
+----------------------------------+--------------------------------------------+----------------------------------------------+
127+
| `Kill Statistics`_ (List) | :meth:`KillStatistics.from_content` | :meth:`Client.fetch_kill_statistics` |
128+
+----------------------------------+--------------------------------------------+----------------------------------------------+
129+
| Leaderboards_ | :meth:`Leaderboard.from_content` | :meth:`Client.fetch_leaderboard` |
130+
+----------------------------------+--------------------------------------------+----------------------------------------------+
131+
| News_ (Individual) | :meth:`News.from_content` | :meth:`Client.fetch_news` |
132+
+----------------------------------+--------------------------------------------+----------------------------------------------+
133+
|| News_ (List) || :meth:`NewsArchive.from_content` || :meth:`Client.fetch_news_archive` |
134+
|| || || :meth:`Client.fetch_recent_news` |
135+
+----------------------------------+--------------------------------------------+----------------------------------------------+
136+
| `Spell Library`_ (List) | :meth:`SpellsSection.from_content` | :meth:`Client.fetch_spells` |
137+
+----------------------------------+--------------------------------------------+----------------------------------------------+
138+
| `Spell Library`_ (Individual) | :meth:`Spell.from_content` | :meth:`Client.fetch_spell` |
139+
+----------------------------------+--------------------------------------------+----------------------------------------------+
140+
| Tournaments_ | :meth:`Tournament.from_content` | :meth:`Client.fetch_tournament` |
141+
+----------------------------------+--------------------------------------------+----------------------------------------------+
142+
| `Tournament Leaderboards`_ | :meth:`TournamentLeaderboard.from_content` | :meth:`Client.fetch_tournament_leaderboard` |
143+
+----------------------------------+--------------------------------------------+----------------------------------------------+
144+
| Worlds_ (Individual) | :meth:`World.from_content` | :meth:`Client.fetch_world` |
145+
+----------------------------------+--------------------------------------------+----------------------------------------------+
146+
| Worlds_ (List) | :meth:`WorldOverview.from_content` | :meth:`Client.fetch_world_list` |
147+
+----------------------------------+--------------------------------------------+----------------------------------------------+
148+
149+
150+
.. _Boostable Bosses: https://www.tibia.com/library/?subtopic=boostablebosses
148151
.. _Characters: https://www.tibia.com/community/?subtopic=characters
149152
.. _Character Bazaar: https://www.tibia.com/charactertrade/?subtopic=currentcharactertrades
150153
.. _CM Post Archive: https://www.tibia.com/forum/?subtopic=forum&action=cm_post_archive

0 commit comments

Comments
 (0)