sharinghub-docs/mkdocs.yml at main · csgroup-oss/sharinghub-docs · 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
140
# Project information
site_name: "SharingHub Docs"
site_description: "Documentation of the SharingHub."
copyright: "Copyright &copy; 2024, CS Group"

# Configuration
dev_addr: "127.0.0.1:5000"
site_dir: "build/html"
docs_dir: "src"
theme:
  name: material
  language: en
  features:
    - content.code.copy
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  logo: assets/img/logo-white.png
  favicon: assets/img/favicon.ico
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: lime
      toggle:
        icon: material/weather-night
        name: Switch to light mode

# Extensions
markdown_extensions:
  - abbr
  - attr_list
  - admonition
  - footnotes
  - md_in_html
  - pymdownx.betterem
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: [".", "src"]
      check_paths: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - tables
  - toc:
      permalink: true

# Plugins
plugins:
  - macros:
      render_by_default: false
  - search:
      lang: en
  - swagger-ui-tag
  - tags

# Page tree
nav:
  - Home:
      - index.md
      - Design:
        - design/philosophy.md
        - design/architecture.md
      - Legal Notice:
          - legal/license.md
          - legal/privacy.md
  - Explore:
      - explore/overview.md
      - explore/categories.md
      - Website:
          - explore/login.md
          - explore/search.md
          - explore/project-view.md
      - API:
          - explore/api-auth.md
          - explore/api-stac.md
          - explore/api-reference.md
  - Share:
      - share/overview.md
      - Metadata:
          - share/metadata/index.md
          - share/metadata/configuration.md
          - share/metadata/stac-concepts.md
          - share/metadata/reference.md
      - Data:
          - share/data/index.md
          - Git LFS: share/data/git-lfs.md
          - DVC: share/data/dvc.md
      - ML Tracking:
          - share/ml-tracking/index.md
          - GitLab Integration: share/ml-tracking/gitlab.md
          - SharingHub Integration: share/ml-tracking/mlflow-sharinghub.md
      - Examples:
          - share/examples/model-case.md
          - share/examples/dataset-case.md
  - Tutorials:
      - tutorials/dataset_with_dvc.md
      - tutorials/dataset_with_huggingface_interface.md
  - Resources:
      - resources/index.md
      - resources/stac.md
      - resources/ogc.md

# Footer links
extra:
  social:
    - icon: fontawesome/brands/github
      link: "https://github.com/csgroup-oss/sharinghub"
    - icon: fontawesome/solid/copyright
      link: "https://www.csgroup.eu"