claimed/mkdocs.yml at main · claimed-framework/claimed · 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
site_name: CLAIMED Framework
site_url: https://claimed-framework.github.io/claimed/
site_description: >-
  The CLAIMED framework – C3 Component Compiler, MLX backend,
  terratorch-iterate HPO launcher, and a library of ready-to-use AI components.
site_author: The CLAIMED authors
repo_name: claimed-framework/claimed
repo_url: https://github.com/claimed-framework/claimed
edit_uri: edit/main/docs/

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  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:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - content.code.copy
    - content.code.select
    - content.action.edit

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [src, .]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            heading_level: 2
            merge_init_into_class: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - attr_list
  - md_in_html
  - toc:
      permalink: true

extra:
  version:
    provider: mike
    default: latest

nav:
  - Home: index.md
  - Roadmap: roadmap.md
  - Getting Started: getting-started.md
  - CLI Reference: cli.md
  - C3 – Component Compiler:
      - Overview: c3/index.md
      - create_operator: c3/create-operator.md
      - create_gridwrapper: c3/create-gridwrapper.md
      - operator_utils: c3/operator-utils.md
  - Job Coordinator: jobcoordinator.md
  - MLX Backend:
      - Overview: mlx/index.md
      - cos_backend: mlx/cos-backend.md
      - s3_kv_store: mlx/s3-kv-store.md
  - Components:
      - util/cosutils: components/util/cosutils.md
      - util/gpu_performance_test: components/util/gpu-benchmark.md
  - terratorch-iterate:
      - iterate2: iterate2.md
      - MLflow: mlflow.md
      - New backbone: new_backbone.md
      - Ray: ray.md
      - Plotting: plotting.md
      - Repeating experiments: repeating_experiments.md
      - Troubleshooting: troubleshooting.md
      - For developers: for_developers.md
      - Handover: handover.md
  - Contributing: contributing.md