-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
144 lines (136 loc) · 5.52 KB
/
mkdocs.yml
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
site_name: COINES Documentation
site_url: https://frickly-systems.gitlab.io/bst/coines-documentation
repo_url: https://github.com/frickly-systems/bst-coines-documentation
theme:
name: material
logo: assets/logo.svg
favicon: assets/logo.svg
palette:
- media: "(prefers-color-scheme: light)"
# scheme: default
# primary: deep purple
# accent: pink
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: red
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.expand
- navigation.top
- header.autohide
- content.code.copy
extra_css:
- stylesheets/extra.css
nav:
- Introduction: 'index.md'
- Acessing the sensor on Application Board using C and SensorAPI:
- Introduction to COINES: 'accessing_the_sensor_on_application_board/introduction_to_coines.md'
- Working Principles:
- Running examples on PC side: 'accessing_the_sensor_on_application_board/running_examples_on_pc_side.md'
- Running examples directly on the MCU of the Application board: 'accessing_the_sensor_on_application_board/running_examples_directly_on_the_mcu_of_the_application_board.md'
- Installation:
- System requirements: 'installation/system_requirements.md'
- Windows: 'installation/windows.md'
- Linux / MacOS: 'installation/linux_macos.md'
- Quickstart:
- Compiling and executing code: 'quickstart/compiling_and_executing_code.md'
- Cross compiling and downloading example to Application Board's microcontroller: 'quickstart/cross_compiling_and_downloading_example_to_application_board_microcontroller.md'
- Eclipse project for examples: 'quickstart/eclipse_project_for_examples.md'
- coinesAPI description:
- Overview of PC side implementations of COINES: 'coines_api/overview_of_pc_side_implementation_of_coines.md'
- GPIO Mapping:
- APP2.0 shuttle board pins: 'coines_api/gpio_mapping/app20_shuttle_board.md'
- APP3.0 shuttle board pins: 'coines_api/gpio_mapping/app30_shuttle_board.md'
- coinesAPI calls:
- Inferface and board information: 'coines_api/api_calls/interface_and_board_information.md'
- GPIO oriented calls: 'coines_api/api_calls/gpio_oriented_calls.md'
- Sensor communication: 'coines_api/api_calls/sensor_communication.md'
- Streaming feature: 'coines_api/api_calls/streaming_feature.md'
- Other useful APIs: 'coines_api/api_calls/other.md'
- Extending the usage of the example files:
- Simple data logging: 'extending_the_usage_of_example_files/simple_data_logging.md'
- Data plotting and visualization: 'extending_the_usage_of_example_files/data_plotting_and_visualization.md'
- Media Transfer Protocol (MTP) firmware for Application Board 3.0:
- MTP fimrware for Application Board 3.0: 'mtp_firmware_for_app30/mtp_firmware_for_app30.md'
- Switching to MTP mode: 'mtp_firmware_for_app30/switching_to_mtp_mode.md'
- Copying the files using MTP: 'mtp_firmware_for_app30/copying_files_using_mtp.md'
- USB/BLE DFU bootloader:
- USB/BLE DFU bootloader: 'usb_ble_dfu_bootloader/usb_ble_dfu_bootloader.md'
- Key Features: 'usb_ble_dfu_bootloader/key_features.md'
- Invoking the Bootloader: 'usb_ble_dfu_bootloader/invoking_the_bootloader.md'
- Using the Bootloader via USB: 'usb_ble_dfu_bootloader/using_with_usb.md'
- Using the Bootloader via BLE: 'usb_ble_dfu_bootloader/using_with_ble.md'
- Updating Bootloader, DD firmware and MTP firmware using COINES:
- Updating bootloader: 'updating_bootloader_dd_firmware_and_mtp_firmware/bootloader.md'
- Updating DD firmware: 'updating_bootloader_dd_firmware_and_mtp_firmware/dd_firmware.md'
- Updating MTP firmware: 'updating_bootloader_dd_firmware_and_mtp_firmware/mtp_firmware.md'
- Accessing the Application Board using Python: 'py_api/py_api.md'
- FAQ: 'faq.md'
- Legal disclaimer: 'legal_disclaimer.md'
markdown_extensions:
- toc:
permalink: true
- attr_list
- md_in_html
- footnotes
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.caret
- pymdownx.tilde
- pymdownx.arithmatex:
generic: true
extra_javascript:
- javascripts/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
plugins:
# - with-pdf:
# author: Bosch Sensortec
# copyright: Copyright Notice
# #
# cover: true
# back_cover: false
# cover_title: COINES Documentation
# cover_subtitle: COmmunication for INertial and Environmental Sensors
#custom_template_path: TEMPLATES PATH
#
#toc_title: TOC TITLE TEXT
#heading_shift: false
#toc_level: 3
#ordered_chapter_level: 2
#excludes_children:
# - 'release-notes/:upgrading'
# - 'release-notes/:changelog'
#
#exclude_pages:
# - 'bugs/'
# - 'appendix/contribute/'
#convert_iframe:
# - src: IFRAME SRC
# img: POSTER IMAGE URL
# text: ALTERNATE TEXT
# - src: ...
#two_columns_level: 3
#
#render_js: true
#headless_chrome_path: headless-chromium
#
#output_path: any-place/document.pdf
#enabled_if_env: ENABLE_PDF_EXPORT
#
#debug_html: true
#show_anchors: true
#verbose: true