CodeClash/mkdocs.yml at main · CodeClash-ai/CodeClash · 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
128
129
130
site_name: CodeClash Documentation

site_url: https://docs.codeclash.ai

repo_url: https://github.com/CodeClash-ai/CodeClash
repo_name: CodeClash-ai/CodeClash
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/clash.svg
  favicon: assets/clash.svg
  icon:
    repo: fontawesome/brands/github
    annotation: material/chevron-right-circle
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    - scheme: default
      primary: green
      accent: light green
      media: "(prefers-color-scheme: light)"
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: light green
      media: "(prefers-color-scheme: dark)"
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - navigation.indexes
    - navigation.tabs
    - navigation.top
    - content.action.edit
    - navigation.footer
    - content.code.copy
    - content.footnote.tooltips
    - header.autohide
    - announce.dismiss
    - content.code.annotate

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences
  - pymdownx.magiclink
  - footnotes
  - attr_list
  - md_in_html
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Leaderboard: https://codeclash.ai/
  - Docs:
    - "About": index.md
    - "Quick Start": quickstart.md
    - API Reference:
      - "reference/index.md"
      - Arenas:
        - "CodeGame (Abstract)": "reference/arenas/game.md"
        - "BattleCode": "reference/arenas/battlecode.md"
        - "BattleSnake": "reference/arenas/battlesnake.md"
        - "Bridge": "reference/arenas/bridge.md"
        - "CoreWar": "reference/arenas/corewar.md"
        - "CybORG": "reference/arenas/cyborg.md"
        - "Halite": "reference/arenas/halite.md"
        - "Halite II": "reference/arenas/halite2.md"
        - "Halite III": "reference/arenas/halite3.md"
        - "HuskyBench": "reference/arenas/huskybench.md"
        - "RoboCode": "reference/arenas/robocode.md"
        - "RobotRumble": "reference/arenas/robotrumble.md"
        - "SCML": "reference/arenas/scml.md"
        - "DummyArena": "reference/arenas/dummy.md"
      - Player:
        - "Player (Abstract)": "reference/player/player.md"
        - "MiniSWEAgent": "reference/player/minisweagent.md"
        - "DummyAgent": "reference/player/dummy.md"
      - Tournament:
        - "AbstractTournament": "reference/tournament/tournament.md"
        - "PvP": "reference/tournament/pvp.md"
        - "SinglePlayer": "reference/tournament/single_player.md"
  - Insights: https://codeclash.ai/insights/
  - Team: https://codeclash.ai/team/

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            merge_init_into_class: true
            summary: false
            show_root_heading: true
            heading_level: 2
            docstring_style: google
            show_if_no_docstring: true
            show_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            separate_signature: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            filters:
              - "!^_"

extra_css:
  - assets/custom.css
  - assets/navigation_cards.css
  - assets/bubbles.css
  - https://fonts.googleapis.com/icon?family=Material+Icons

extra:
  analytics:
    provider: google
    property: G-N8Q0B783CD