Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all resources to documentation. #15

Open
16 tasks
THEGOLDENPRO opened this issue Nov 25, 2024 · 0 comments
Open
16 tasks

Add all resources to documentation. #15

THEGOLDENPRO opened this issue Nov 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@THEGOLDENPRO
Copy link
Owner

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.

  • genres
  • manga
  • 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)
@THEGOLDENPRO THEGOLDENPRO added the documentation Improvements or additions to documentation label Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant