overstep/mkdocs.yml at main · LakoreAI/overstep · 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: overstep
site_description: Lightweight boundary violation detection, spatial analytics, and tracking library.
site_url: https://github.com/overstep/overstep

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_root_heading: true
            show_source: true
            heading_level: 2

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - tables

nav:
  - Home: index.md
  - Quickstart: quickstart.md
  - User Guides:
      - Point-in-Polygon Suite: guide/geometry.md
      - Boundary Zones: guide/boundaries.md
      - Kalbee Tracking & Re-ID: guide/tracking.md
      - Crowd & Social Distance: guide/crowd.md
      - Analytics & TTC Forecasting: guide/analytics.md
      - Multi-Tripwires & Breaches: guide/tripwire.md
      - GeoJSON & GIS Integration: guide/geojson.md
      - Multi-Camera Aggregation: guide/multicam.md
  - API Reference:
      - Core Dataclasses: api/types.md
      - Geometry Primitives: api/geometry.md
      - Boundary Zones: api/boundary.md
      - Kalbee Tracker & Re-ID: api/tracking.md
      - Crowd & Analytics: api/analytics.md
      - Tripwires & Reports: api/reporting.md
      - GIS & Serializers: api/gis.md
      - Adapters & Visualization: api/adapters.md