kickcom.py/mkdocs.yml at main · PredaaA/kickcom.py · 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
site_name: kickcom.py
site_url: https://predaaa.github.io/kickcom.py
site_description: Modern async Python wrapper for the Kick.com API with OAuth 2.1 PKCE, typed models, and webhook support
repo_url: https://github.com/PredaaA/kickcom.py
repo_name: PredaaA/kickcom.py

theme:
  name: material
  custom_dir: overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: green
      accent: green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: green
      accent: green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate
    - search.highlight

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: true
            members_order: source
            docstring_style: numpy
            merge_init_into_class: true

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true

extra:
  umami:
    website_id: "0f137296-6b79-4173-be23-60b4c58defa0"

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Authentication: authentication.md
  - API Reference:
      - KickClient: api/client.md
      - Models: api/models.md
      - Enums: api/enums.md
      - Errors: api/errors.md
  - Webhooks:
      - Setup: webhooks/setup.md
      - Events: webhooks/events.md