modern-yolonas/mkdocs.yml at main · CondadosAI/modern-yolonas · 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
site_name: modern-yolonas
site_description: Modern YOLO-NAS object detection — clean reimplementation
site_url: https://condadosai.github.io/modern-yolonas/
repo_url: https://github.com/CondadosAI/modern-yolonas
repo_name: CondadosAI/modern-yolonas

theme:
  name: material
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.sections
    - navigation.expand
    - content.code.copy
    - content.code.annotate
    - search.highlight

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - CLI Reference: cli.md
  - API Reference:
    - Detector: api/detector.md
    - YoloNAS Model: api/model.md
    - Training: api/training.md
    - Data: api/data.md
    - Weights: api/weights.md
  - Guides:
    - Training: guides/training.md
    - Export: guides/export.md
    - Extending: guides/extending.md
  - Architecture: architecture.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            members_order: source
            docstring_style: google

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true