forked from eclipse-tractusx/tractusx-sdk
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
170 lines (162 loc) · 7.53 KB
/
mkdocs.yml
File metadata and controls
170 lines (162 loc) · 7.53 KB
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
###############################################################
# Eclipse Tractus-X - Tractus-X SDK
#
# Copyright (c) 2025 LKS Next
# Copyright (c) 2025 Mondragon Unibertsitatea
# Copyright (c) 2025 Contributors to the Eclipse Foundation
#
# See the NOTICE file(s) distributed with this work for additional
# information regarding copyright ownership.
#
# This program and the accompanying materials are made available under the
# terms of the Apache License, Version 2.0 which is available at
# https://www.apache.org/licenses/LICENSE-2.0.
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
#
# SPDX-License-Identifier: Apache-2.0
###############################################################
site_name: Tractus-X SDK Documentation
site_description: A comprehensive SDK for Eclipse Tractus-X components
repo_url: https://github.com/eclipse-tractusx/tractusx-sdk
repo_name: eclipse-tractusx/tractusx-sdk
edit_uri: edit/main/docs/
theme:
name: material
favicon: assets/images/logo_tractus-x-min.ico
logo: assets/images/logo_tractus-x.svg
custom_dir: docs/overrides
palette:
# Orange and Black custom theme
- scheme: default
primary: custom
accent: orange
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Dark mode with orange accents
- scheme: slate
primary: custom
accent: orange
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs # Renders top-level navigation as tabs
- navigation.sections # Groups navigation items into sections
- navigation.expand # Automatically expands navigation sections
- navigation.top # Adds back-to-top button for easy page navigation
- navigation.instant # Instant navigation for faster page loads
- navigation.tracking # Anchor tracking for better UX
- search.highlight # Highlights search terms in results
- search.share # Adds share button to search results
- search.suggest # Search suggestions
- content.code.copy # Adds copy button to code blocks
- content.code.annotate # Allows annotations in code blocks
- content.action.edit # Adds edit button to pages (links to repository)
- content.tabs.link # Links content tabs across pages
- toc.follow # Sidebar automatically scrolls to active section
plugins:
- search # Enables site-wide search functionality
- mkdocstrings: # Automatically generates API documentation from Python docstrings
default_handler: python
handlers:
python:
options:
docstring_style: google
extra:
version:
provider: mike
extra_css:
- assets/stylesheets/orange-black-theme.css
markdown_extensions:
- admonition # Creates callout boxes (notes, warnings, tips, etc.)
- pymdownx.details # Adds collapsible content sections
- pymdownx.superfences: # Enhanced code blocks with nesting support
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed: # Creates tabbed content blocks
alternate_style: true
- pymdownx.highlight: # Syntax highlighting for code blocks
anchor_linenums: true # Makes line numbers clickable links
line_spans: __span
pygments_lang_class: true
use_pygments: true
pygments_style: monokai # VS Code-like dark theme
auto_title: true # Automatically adds language title to code blocks
- pymdownx.inlinehilite # Syntax highlighting for inline code
- pymdownx.snippets # Includes external code files in documentation
- pymdownx.emoji: # Emoji support
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- attr_list # Adds CSS classes and attributes to Markdown elements
- md_in_html # Allows Markdown syntax inside HTML blocks
- def_list # Definition lists
- pymdownx.tasklist: # Task lists
custom_checkbox: true
- pymdownx.keys # Keyboard keys
- pymdownx.mark # Text highlighting
- pymdownx.tilde # Strikethrough
- pymdownx.caret # Superscript
nav:
- Home: index.md
- Tutorials:
- Installation & Setup: tutorials/getting-started.md
- Create First Asset: tutorials/create-first-asset.md
- How-to Guides:
- Industry Core Hub Use Case: how-to-guides/ic-hub-use-case/industry-core-hub-overview.md
- Other Use Case: how-to-guides/other-use-case/other-use-case-overview.md
- Core Concepts:
- SDK Architecture: core-concepts/sdk-architecture/sdk-structure-and-components.md
- Dataspace Concepts: core-concepts/dataspace-concepts/index.md
- Industry Concepts: core-concepts/industry-concepts/index.md
- Extensions Concepts: core-concepts/extensions-concepts/index.md
- Authentication & Security: core-concepts/authentication-security/authentication.md
- API Reference:
- Dataspace Library:
- Overview: api-reference/dataspace-library/index.md
- Connector:
- Services: api-reference/dataspace-library/connector/services.md
- Models: api-reference/dataspace-library/connector/models.md
- Managers: api-reference/dataspace-library/connector/managers.md
- Controllers: api-reference/dataspace-library/connector/controllers.md
- Discovery Services:
- Discovery Finder Service: api-reference/dataspace-library/discovery-services/discovery-finder-service.md
- Connector Discovery Service: api-reference/dataspace-library/discovery-services/connector-discovery-service.md
- Tools: api-reference/dataspace-library/tools/tools.md
- Legacy:
- Connector: api-reference/dataspace-library/legacy/edc-sdk-usage.md
- Industry Library:
- Overview: api-reference/industry-library/index.md
- DTR:
- Services: api-reference/industry-library/dtr/services.md
- Models: api-reference/industry-library/dtr/models.md
- Submodel Server:
- Adapters:
- Base Adapter: api-reference/industry-library/submodel-server/adapters/base-adapter.md
- File System Adapter: api-reference/industry-library/submodel-server/adapters/file-system-adapter.md
- Discovery Services:
- BPN Discovery: api-reference/industry-library/discovery-services/bpn-discovery.md
- Legacy:
- DTR: api-reference/industry-library/legacy/dtr-sdk-usage.md
- Submodel Server: api-reference/industry-library/legacy/submodel-server-sdk-usage.md
- Extension Library:
- Overview: api-reference/extension-library/index.md
- Semantics: api-reference/extension-library/semantics/semantics.md
- Contributing:
- Contribution Guidelines: contributing/contribution-guidelines.md
- Code of Conduct: contributing/code-of-conduct.md
- Architectural Decision Records:
- 1.- Record Architecture Decisions: contributing/architectural-decisions/0001-record-architecture-decisions.md
- 2.- Data Storage Architecture: contributing/architectural-decisions/0002-data-storage-architecture.md
- 3.- SDK Module Architecture: contributing/architectural-decisions/0003-sdk-module-architecture.md
- 4.- Tractus-X SDK Service: contributing/architectural-decisions/0004-tractusx-sdk-services.md
- Versioning: contributing/versioning/VERSIONING.md
copyright: >
Copyright © 2025 Eclipse Tractus-X