mcsrranked-python/mkdocs.yml at main · camodotgg/mcsrranked-python · 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
site_name: MCSR Ranked Python SDK
site_description: Python SDK for the MCSR Ranked API.
site_url: https://camodotgg.github.io/mcsrranked-python
repo_url: https://github.com/camodotgg/mcsrranked-python
repo_name: camodotgg/mcsrranked-python

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: false
            show_root_heading: true
            show_bases: false
            heading_level: 3
            members_order: source
            show_root_full_path: false
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            summary: true
            filters:
              - "!^model_config$"
              - "!^model_fields$"
              - "!^model_computed_fields$"
            extensions:
              - griffe_pydantic:
                  schema: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
  - User Guide:
      - Users: guide/users.md
      - Matches: guide/matches.md
      - Leaderboards: guide/leaderboards.md
      - Live Data: guide/live.md
      - Weekly Races: guide/weekly-races.md
      - Error Handling: guide/error-handling.md
      - Async Usage: guide/async.md
  - API Reference:
      - Client: api/client.md
      - Types: api/types.md
      - Exceptions: api/exceptions.md
  - Examples: examples.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/camodotgg/mcsrranked-python