wurzel/mkdocs.yml at main · telekom/wurzel · 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
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# SPDX-FileCopyrightText: 2024 Deutsche Telekom AG
#
# SPDX-License-Identifier: CC0-1.0

site_name: Wurzel
site_description: Wurzel documentation
site_author: Deutsche Telekom AG
site_url: https://telekom.github.io/wurzel/
repo_url: https://github.com/telekom/wurzel
repo_name: telekom/wurzel
# Repository information
#repo_name: knowledge-pipe/documentation

#edit_uri: -/edit/main/documentation/docs/

# Theme configuration with Telekom Magenta branding
theme:
  name: material
  custom_dir: docs/static/overrides/
  palette:
    # Telekom Magenta primary color scheme
    - scheme: default
      primary: custom  # We'll define custom magenta color
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.action.edit
    - content.action.view
    - toc.follow
    - toc.integrate

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    logo: material/library

  favicon: assets/images/favicon.ico

  font:
    text: TeleNeoWeb
    code: Roboto Mono

# Plugins
plugins:
  - search:
      lang: en
  - autorefs
  - mermaid2:
      javascript: https://unpkg.com/mermaid@10/dist/mermaid.esm.min.mjs
  - minify:
      minify_html: false
  - mkdocs-typer2:
      pretty: true
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_root_members_full_path: false
            show_category_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true


# Markdown extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - tables
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - pymdownx.keys
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true

# Navigation structure

nav:
  - Home: index.md
  - Developer Guide:
    - Overview: developer-guide/index.md
    - Installation: developer-guide/installation.md
    - Getting Started: developer-guide/getting-started.md
    - Cli Reference: developer-guide/cli.md
    - Building Pipelines: developer-guide/building-pipelines.md
    - Runtime vs. Generate Time: developer-guide/runtime_vs_generatetime.md
    - Creating Custom Steps: developer-guide/creating-steps.md
    - Data Contracts: developer-guide/data-contracts.md
  - Backends:
      - Overview: backends/index.md
      - Argo Workflows: backends/argoworkflows.md
      - DVC: backends/dvc.md
  - Executor:
      - Overview: executor/index.md
      - Middlewares: executor/middlewares.md
  - Steps:
    - Docling: steps/docling.md
    - Deduplication: steps/duplication.md
    - Embedding: steps/embedding.md
    - Manual Markdown: steps/manual_markdown.md
    - Qdrant: steps/qdrant.md
    - Milvus: steps/milvus.md
    - ScraperAPI: steps/scraperapi.md
    - Splitter: steps/splitter.md
    - SFTP Manual Markdown: steps/sftp.md


# Custom CSS and JavaScript
extra_css:
  - static/stylesheets/telekom-magenta.css
  - static/stylesheets/custom.css

extra_javascript:
  - static/javascripts/config.js

# Copyright
copyright: Copyright &cop - Telekom