ambr/mkdocs.yml at main · seriaati/ambr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
# Project information
site_name: ambr
site_url: https://gh.seria.moe/ambr
site_author: Seria Ati
site_description: An async API wrapper for Project Amber (gi.yatta.moe) written in Python.

# Repository
repo_name: seriaati/ambr
repo_url: https://github.com/seriaati/ambr

# Copyright
copyright: Copyright &copy; 2025 - 2025 Seria Ati

# Configuration
theme:
  name: material
  features:
    - navigation.tabs
    - navigation.instant
    - content.code.copy
    - content.code.annotate
  language: en
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
      primary: red
      accent: red

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
      primary: red
      accent: red

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
      primary: red
      accent: red

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: ["genshin"]
          inventories:
            - https://docs.python.org/3/objects.inv
            - https://mkdocstrings.github.io/griffe/objects.inv
            - https://docs.pydantic.dev/latest/objects.inv
          options:
            backlinks: tree
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            parameter_headings: true
            relative_crossrefs: true
            scoped_crossrefs: true
            type_parameter_headings: true
            show_root_heading: true
            show_root_full_path: false
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_if_no_docstring: true
            show_source: false
            show_bases: false
            separate_signature: true
            signature_crossrefs: true
            show_symbol_type_toc: true
            show_signature_annotations: true
            show_signature_type_parameters: true
            summary: true
            filters:
              - "!^_"
            unwrap_annotated: true
            extensions:
              - griffe_pydantic:
                  schema: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets

nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - API Reference:
      - Client: reference/client.md
      - Exceptions: reference/exceptions.md
      - Enums: reference/enums.md
      - Utils: reference/utils.md
      - Models:
          - Abyss: reference/models/abyss.md
          - Achievement: reference/models/achievement.md
          - Artifact: reference/models/artifact.md
          - Book: reference/models/book.md
          - Changelog: reference/models/changelog.md
          - Character: reference/models/character.md
          - Character Fetter: reference/models/character_fetter.md
          - Domain: reference/models/domain.md
          - Food: reference/models/food.md
          - Furniture: reference/models/furniture.md
          - Guides: reference/models/guides.md
          - Material: reference/models/material.md
          - Monster: reference/models/monster.md
          - Name Card: reference/models/name_card.md
          - Quest: reference/models/quest.md
          - TCG: reference/models/tcg.md
          - Upgrade: reference/models/upgrade.md
          - Weapon: reference/models/weapon.md