gdpy/mkdocs.yml at main · Lachine1/gdpy · 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
site_name: gdpy
site_description: A modern Python client for the Geometry Dash API
site_url: https://lachine1.github.io/gdpy
repo_url: https://github.com/Lachine1/gdpy
repo_name: Lachine1/gdpy

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tooltips
    - header.autohide
    - toc.follow

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - API Coverage: api-coverage.md
  - API Reference:
    - Client: api/client.md
    - Models: api/models.md
    - Exceptions: api/exceptions.md
    - Crypto: api/crypto.md
  - Examples: examples.md

plugins:
  - search
  - autorefs
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
  - open-in-new-tab
  - mkdocstrings:
      handlers:
        python:
          paths: [gdpy]
          options:
            docstring_style: google
            show_source: true
            show_signature_annotations: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            merge_init_into_class: true
            separate_signature: true
            filters: ["!^_"]

markdown_extensions:
  - toc:
      permalink: true
      permalink_title: Link to this section
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - footnotes
  - attr_list
  - md_in_html