object-detection-training/mkdocs.yml at develop · ortizeg/object-detection-training · 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
site_name: Object Detection Training
site_description: Training framework for RFDETR and YOLOX object detection models
site_url: https://ortizeg.github.io/object-detection-training
repo_url: https://github.com/ortizeg/object-detection-training
repo_name: ortizeg/object-detection-training

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy
    - navigation.sections
    - navigation.expand
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      enabled: true
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            members_order: source
            allow_inspection: false

nav:
  - Home: index.md
  - Getting Started: getting-started.md
  - Configuration: configuration.md
  - Contributing: contributing.md
  - API Reference:
      - Models: api/models.md
      - Callbacks: api/callbacks.md
      - Data: api/data.md
      - Metrics: api/metrics.md
      - Schemas: api/schemas.md
      - Transforms: api/transforms.md
      - Utils: api/utils.md
      - Tasks: api/tasks.md
      - Types: api/types.md

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