opendata/mkdocs.yml at master · SkillCorner/opendata · 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
site_name: SkillCorner Open Data
site_url: https://SkillCorner.github.io/opendata/

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

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy
    - content.code.annotate
  font:
    text: Chakra Petch
    code: Roboto Mono

extra_css:
  - stylesheets/extra.css

markdown_extensions:
  - attr_list

# docs/tools is a symlink to viz_tools/; publish the HTML apps but not their README
exclude_docs: |
  tools/README.md

plugins:
  - search
  - tags
  - mkdocs-jupyter:
      execute: false
      include_requirejs: true
      include_source: true

nav:
  - Home: index.md
  - Tutorials:
    - 'Overview': notebooks/tutorials/README.md
    - 'Path 01: Getting Started':
      - '📖 Normalization Basics': notebooks/tutorials/01_Getting_Started_with_SkillCorner_Data/DATA_NORMALIZATION_BASICS.md
      - '🎨 Visualization Tutorial': notebooks/tutorials/01_Getting_Started_with_SkillCorner_Data/Part1_Visualization_with_SkillCorner_Tutorial.ipynb
      - '📊 Multiple Metrics & Z-Scores': notebooks/tutorials/01_Getting_Started_with_SkillCorner_Data/Part2_Multiple_Metrics_and_Z_Scores_Tutorial.ipynb
      - '🎯 Building Striker Archetypes': notebooks/tutorials/01_Getting_Started_with_SkillCorner_Data/Part3_Building_Striker_Archetypes_Tutorial.ipynb
    - 'Path 02: Game Intelligence':
      - '📊 Part 1: Aggregating Events': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part1_Aggregating_Dynamic_Events_Tutorial.ipynb
      - '📊 Part 2: Phases of Play': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part2_Data_Aggregating_Phases_of_Play_Tutorial.ipynb
      - '🏃 Part 3: Off-ball Runs': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part3_Offball_Runs_Pitch_visualization.ipynb
      - '🔗 Part 4: Merging Track/Event': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part4_Merging_Dynamic_Events_and_Tracking_Data_Tutorial.ipynb
      - '🎬 Part 5: Animated Video': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part5_Animated_2D_Video_From_Tracking_And_Events.ipynb
      - '📈 Part 6: Build Your Own Metric': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part6_BuildYourOwnMetric_Detecting_and_Evaluating_Cutback_Opportunities.ipynb
      - '🗺️ Part 7: Pitch Maps by Phase': notebooks/tutorials/02_Working_with_Game_Intelligence_and_Dynamic_Events/Part7_Pitch_Maps_Tracking_by_Phase_Tutorial.ipynb
    - 'Path 03: Basics of Tracking':
      - '📍 Tracking Core': notebooks/tutorials/03_Basics_of_Tracking/Open_Data_Tracking_Tutorial.ipynb
      - '🚀 Kloppy Integration': notebooks/tutorials/03_Basics_of_Tracking/Open_Data_Getting_Started_with_Tracking_and_Kloppy_Tutorial.ipynb
    - 'Path 04: Visualizations':
      - '📊 Sectioned Summary Table': notebooks/tutorials/04_Visualizations/Sectioned_Summary_Table_Viz_Tutorial.ipynb
      - '📡 OffBall Runs Radar': notebooks/tutorials/04_Visualizations/OBR_Simple_Radar_Viz.ipynb
  - '🛠️ Viz Tools': viz_tools.md
  - Source Code Setup: src.md