opensportslib/mkdocs.yml at main · OpenSportsLab/opensportslib · 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
site_name: OpenSportsLib
site_description: OpenSportsLib is the professional library, designed for advanced video understanding in soccer. It provides state-of-the-art tools for action recognition, spotting, retrieval, and captioning, making it ideal for researchers, analysts, and developers working with soccer video data.
repo_url: https://github.com/OpenSportsLab/opensportslib
repo_name: OpenSportsLab/opensportslib

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - content.code.copy
    - content.tabs.link
    - search.highlight
    - search.suggest
    - toc.integrate
    - content.action.edit

  palette:
    - scheme: default
      primary: green
      accent: lime
    - scheme: slate
      primary: green
      accent: lime

nav:
  - Home: index.md

  - Getting Started:
      - Installation: getting-started/installation.md
      - Project Structure: getting-started/project_structure.md
      - SLURM Guide (salloc, srun): getting-started/slurm.md

  - Training & Inference:
      - Training & Inference: tni/tni.md
      - Configuration Guide: tni/config-guide.md

  - API Reference:
      - API: api/api.md

  - Contributing: contributing.md


plugins:
  - search
  - include-markdown:
      rewrite_relative_urls: true
  - mkdocstrings:
      handlers:
        python:
          paths: [.]

markdown_extensions:
  - admonition
  - footnotes
  - tables
  - attr_list
  - md_in_html
  - toc:
      permalink: true

  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed

  - pymdownx.snippets:
      base_path: .

  - pymdownx.highlight:
      anchor_linenums: true
      pygments_lang_class: true