trackers/mkdocs.yml at 15e95baa5a1a4e6e3c2bbf473e99bdc19f3a0b00 · roboflow/trackers · 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
131
132
133
134
135
136
137
138
139
site_name: Trackers
site_url: https://roboflow.github.io/trackers/develop/
site_author: Roboflow
site_description: A unified library for object tracking featuring clean room re-implementations of leading multi-object tracking algorithms.
repo_name: roboflow/trackers
repo_url: https://github.com/roboflow/trackers
edit_uri: https://github.com/roboflow/trackers/tree/main/docs
copyright: Roboflow 2026. All rights reserved.

hooks:
  - docs/hooks/doctest_filter.py

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/roboflow
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/trackers
    - icon: fontawesome/brands/docker
      link: https://hub.docker.com/u/roboflow
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/roboflow
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/roboflow-ai/
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/roboflow
    - icon: fontawesome/brands/discord
      link: https://discord.gg/GbfgXGJ8Bk

theme:
  name: material
  custom_dir: docs/overrides/
  icon:
    edit: material/pencil
  logo: assets/logo-trackers-violet.svg
  favicon: assets/logo-trackers-black.svg
  features:
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.tracking
    - navigation.expand
    - navigation.tabs

extra_css:
  - stylesheets/style.css
  - stylesheets/rf.css
  - stylesheets/command_builder.css

extra_javascript:
  - javascripts/pycon_copy.js
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/cli_builder_framework.js
  - javascripts/command_builder.js

markdown_extensions:
   # Adds support for card grids
  - attr_list
  - md_in_html
  # Enables the use of icons and emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # Code syntax highlighting with line numbers and anchors
  - pymdownx.highlight:
      # Adds anchors to line numbers
      anchor_linenums: true
      # Wraps lines in span elements
      line_spans: __span
      # Adds language class to code blocks
      pygments_lang_class: true
  # Enables inline code highlighting
  - pymdownx.inlinehilite
  # Enables LaTeX-style math in Markdown
  - pymdownx.arithmatex:
      generic: true
  # Allows including content from other files
  - pymdownx.snippets
  # Enables nested code blocks and custom fences
  - pymdownx.superfences
  # Adds support for callouts/notes/warnings
  - admonition
  # Enables collapsible blocks (expandable content)
  - pymdownx.details
  # Creates tabbed content (like installation examples)
  - pymdownx.tabbed:
      # Uses an alternative styling for tabs
      alternate_style: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            # Controls whether to show symbol types in the table of contents
            show_symbol_type_toc: true
            # Controls whether to show symbol type in the heading
            show_symbol_type_heading: true
            # Controls whether to show the root heading (module/class name)
            show_root_heading: true
            # Controls whether to show the source code
            show_source: false
            # Specifies the docstring style to parse (Google style in this case)
            docstring_style: google
            # Controls the order of members (by source order in this case)
            members_order: source

            extra:
              # Controls whether to sort members alphabetically
              sort_members: false

nav:
  - Home:
    - Quickstart: index.md
  - Guides:
    - Install Trackers: learn/install.md
    - Track Objects: learn/track.md
    - Download Datasets: learn/download.md
    - Evaluate Trackers: learn/evaluate.md
    - Detection Quality Matters: learn/detection-quality.md
    - State Estimators: learn/state-estimators.md
  - Trackers:
    - Comparison: trackers/comparison.md
    - SORT: trackers/sort.md
    - ByteTrack: trackers/bytetrack.md
    - OC-SORT: trackers/ocsort.md
  - API Reference:
    - Trackers: api/trackers.md
    - Motion: api/motion.md
    - Datasets: api/datasets.md
    - Evals: api/evals.md
    - I/O: api/io.md