Arduino_Core_STM32/mkdocs.yml at main · stm32duino/Arduino_Core_STM32 · 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
site_name: STM32duino
site_description: Documentation for the STM32duino Arduino core and ecosystem
site_url: https://stm32duino.github.io/
repo_name: stm32duino/Arduino_Core_STM32
repo_url: https://github.com/stm32duino/Arduino_Core_STM32
edit_uri: edit/main/docs/

nav:
  - Home: index.md
  - Getting Started:
    - Arduino IDE 2: Getting-Started.md
    - Legacy IDE 1.8.x: Getting-Started_V1.md
    - Upload Methods: Upload-methods.md
    - Examples:
      - Overview: examples/Examples.md
      - Blink: examples/Blink-example.md
    - FAQ: FAQ.md
  - Supported Boards: supported-boards/index.md
  - Core Reference:
    - Arduino API: API.md
    - Hardware Timer: HardwareTimer-library.md
    - Pin Naming: Pin-naming.md
    - STM32MP1: STM32MP1.md
  - Libraries:
    - Overview: libraries/index.md
    - Built-in:
      - CMSIS-DSP: libraries/built-in/CMSIS-DSP-library.md
      - EEPROM: libraries/built-in/EEPROM-library.md
      - I2C: libraries/built-in/I2C-library.md
      - Servo: libraries/built-in/Servo-library.md
      - SPI: libraries/built-in/SPI-library.md
    - Dedicated:
      - LPS22HB: libraries/dedicated/LPS22HB.md
      - LIS3MDL: libraries/dedicated/LIS3MDL.md
      - LSM6DSL: libraries/dedicated/LSM6DSL.md
      - M24SR64-Y: libraries/dedicated/M24SR64-Y.md
      - MX25R6435F: libraries/dedicated/MX25R6435F.md
      - SPBTLE-RF: libraries/dedicated/SPBTLE-RF.md
      - VL53L0X: libraries/dedicated/VL53L0X.md
    - Connectivity:
      - LoRa: libraries/LoRa.md
      - STM32duinoBLE: libraries/STM32duinoBLE.md
    - Hosted library documentation:
      - Library documentation index: libraries/Hosted-library-documentation.md
      - STM32LoRaWAN: https://stm32duino.github.io/STM32LoRaWAN/
      - HTS221: https://stm32duino.github.io/HTS221/
      - STM32Ethernet: https://stm32duino.github.io/STM32Ethernet/
    - Additional libraries and compatibility: libraries/additional-libraries.md
  - Development:
    - Contributing: https://github.com/stm32duino/Arduino_Core_STM32/blob/main/CONTRIBUTING.md
    - Using the Git Repository: development/Using-git-repository.md
    - Source Locations: development/Where-are-sources.md
    - Code Style: development/Astyle.md
    - Add a Board Variant:
      - Overview: development/Add-a-new-variant/overview.md
      - Generic Variant: development/Add-a-new-variant/generic-variant.md
      - Dedicated Board: development/Add-a-new-variant/dedicated-board.md
    - CMake:
      - Introduction: cmake/Introduction-to-CMake.md
      - STM32duino CMake Build System: cmake/STM32duino-CMake-Build-System.md
      - Setup: cmake/Setup.md
      - Quickstart: cmake/Quickstart-guide.md
      - Advanced Usage: cmake/Advanced-usage.md
      - Functions Reference: cmake/Functions-reference.md
      - Arduino Compatibility: cmake/Arduino-(in)compatibility.md
      - CubeIDE: cmake/cubeIDE.md
    - Customization:
      - Custom Definitions: customization/Custom-definitions.md
      - Custom Boards: customization/Custom-board-based-on-a-core.md
      - Build Options: customization/Customize-build-options-using-build_opt.h.md
      - HAL Configuration: customization/HAL-configuration.md
    - IDE:
      - Overview: development/ide/overview.md
      - PlatformIO: development/ide/PlatformIO.md
    - How to Debug:
      - Arduino IDE 2: development/debug/How-to-debug.md
      - Eclipse and Sloeber: development/debug/eclipse-sloeber.md
      - PlatformIO: development/debug/platformio.md
      - Visual Studio and VisualGDB: development/debug/visualgdb.md
      - STM32CubeCLT and cortex-debug: development/debug/cubeclt-cortex-debug.md
      - Command Line GDB: development/debug/command-line-gdb.md
      - Troubleshooting: development/debug/troubleshooting.md
    - Documentation Workflow: development/Documentation-workflow.md

markdown_extensions:
  - toc
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.magiclink
  - pymdownx.superfences

extra_css:
  - inline-code.css
  - supported-boards/supported-boards.css

extra_javascript:
  - supported-boards/supported-boards.js

theme:
  name: material
  logo: img/stm32duino.png
  favicon: img/stm32duino.png
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.copy

plugins:
  - search
  - gh-admonitions

hooks:
  - docs/hooks/supported_boards.py

extra:
  version:
    provider: mike