Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
160 lines (152 loc) · 5.03 KB
/
Copy pathmkdocs.yml
File metadata and controls
160 lines (152 loc) · 5.03 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
site_name: CANExplorer
site_description: Cross-platform CAN and LIN bus monitoring, diagnostics and simulation
site_url: https://akj7.github.io/CANExplorer/
repo_url: https://github.com/AKJ7/CANExplorer
repo_name: AKJ7/CANExplorer
edit_uri: edit/develop/docs/
copyright: Copyright © 2024–2026 AKJ7
theme:
name: material
logo: assets/icon.png
favicon: assets/favicon.png
features:
- navigation.tabs
- navigation.sections
- navigation.top
- navigation.footer
- navigation.indexes
- search.highlight
- search.suggest
- content.code.copy
- content.tabs.link
- toc.follow
palette:
scheme: slate # Recoloured to Dracula by docs/stylesheets/dracula.css
primary: custom
accent: custom
icon:
repo: fontawesome/brands/github
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
anchors: warn
nav:
- Home: index.md
- Getting started:
- getting-started/index.md
- Installation: getting-started/installation.md
- Quick start: getting-started/quick-start.md
- User guide:
- user-guide/index.md
- Connections: user-guide/connections.md
- Trace and overview: user-guide/trace-and-overview.md
- Filters: user-guide/filters.md
- Bus health: user-guide/bus-health.md
- Reverse engineering: user-guide/reverse-engineering.md
- Recording, replay and export: user-guide/recording-and-replay.md
- Comparing recordings: user-guide/compare-recordings.md
- Video and GPS map: user-guide/video-and-map.md
- Several buses: user-guide/multi-bus.md
- Bus gateway: user-guide/bus-gateway.md
- Restbus simulation: user-guide/restbus.md
- Remote buses: user-guide/remote-buses.md
- MCP interface: user-guide/mcp.md
- MQTT: user-guide/mqtt.md
- Signal databases: user-guide/signal-databases.md
- Database editor: user-guide/database-editor.md
- Signal plots: user-guide/signal-plots.md
- Transmitting: user-guide/transmitting.md
- Protocol decoding: user-guide/protocols.md
- Diagnostics (UDS): user-guide/diagnostics.md
- OBD-II: user-guide/obd.md
- Flashing: user-guide/flashing.md
- UDS discovery: user-guide/uds-discovery.md
- XCP/CCP: user-guide/xcp.md
- GMLAN: user-guide/gmlan.md
- J1850 / Class 2: user-guide/j1850.md
- DoIP: user-guide/doip.md
- SOME/IP: user-guide/someip.md
- Ethernet capture: user-guide/ethernet.md
- Security manager: user-guide/security-manager.md
- J1939: user-guide/j1939.md
- CANopen: user-guide/canopen.md
- EtherCAT (CoE): user-guide/ethercat.md
- Physical I/O: user-guide/physical-io.md
- FlexRay: user-guide/flexray.md
- LIN: user-guide/lin.md
- Simulation and scripting: user-guide/simulation.md
- Test automation: user-guide/test-automation.md
- Workspaces: user-guide/workspaces.md
- Preferences and settings: user-guide/preferences.md
- Updates: user-guide/updates.md
- Reference:
- reference/index.md
- Scripting API: reference/scripting-api.md
- Test API: reference/test-api.md
- QML panel API: reference/panel-api.md
- Supported interfaces: reference/interfaces.md
- Command line: reference/command-line.md
- File formats: reference/file-formats.md
- Keyboard shortcuts: reference/keyboard-shortcuts.md
- Links: reference/links.md
- Development:
- development/index.md
- Architecture: development/architecture.md
- Building and testing: development/building.md
- Packaging: development/packaging.md
- Translations: development/translations.md
- Contributing: development/contributing.md
- Changelog: changelog.md
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.snippets:
check_paths: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
plugins:
- search
- mkdocstrings:
handlers:
python:
paths: [.]
options:
docstring_style: google
show_source: false
show_root_heading: true
show_root_full_path: false
show_symbol_type_heading: true
members_order: source
heading_level: 3
filters: ["!^_"]
merge_init_into_class: true
extra_css:
- stylesheets/dracula.css
extra_javascript:
- javascripts/releases.js
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/AKJ7/CANExplorer