We have a documentation site at https://anmoku.devgoldy.xyz/ and it's missing a lot of jikan resource objects we've added recently.
Here's how each resource should be documented. An example is not necessary but the rest (required params and the description at the top) are required.
@dataclass
class Anime(JikanResource):
"""
Get or search for anime.
[`jikan`_]
.. _jikan: https://docs.api.jikan.moe/#tag/anime/operation/getAnimeById
Required Params
-----------------
* `id` - Manga ID
------------
⭐ Example:
------------
Here's an example of how to get an anime by ID and display it's cover art::
from anmoku import Anime, Anmoku
client = Anmoku()
anime = client.get(Anime, id = 13759)
print(
f"Got the anime '{anime.name}', it's english name is '{anime.name.english}' and it was aired in {anime.aired.from_.year}."
)
# Display it's image.
anime.image.get_image().show()
"""
...
This is NOT Markdown, it's Restructured Text so be careful with the syntax or else the docs will fail to parse it.
Progress
A check here should mean that all the resources in that sub category have been doc-stringed and added to the sphinx documentation.
We have a documentation site at https://anmoku.devgoldy.xyz/ and it's missing a lot of jikan resource objects we've added recently.
Here's how each resource should be documented. An example is not necessary but the rest (required params and the description at the top) are required.
This is NOT Markdown, it's Restructured Text so be careful with the syntax or else the docs will fail to parse it.
Progress
A check here should mean that all the resources in that sub category have been doc-stringed and added to the sphinx documentation.
anime(not yet completed)characters(not yet completed)clubs(not yet completed)magazines(not yet completed)people(not yet completed)producers(not yet completed)random(not yet completed)recommendations(not yet completed)reviews(not yet completed)schedules(not yet completed)users(not yet completed)seasons(not yet completed)top(not yet completed)watch(not yet completed)