Commit Graph

9 Commits

Author SHA1 Message Date
Robert Middleton 32032c398c doc: develop: tools: Add STM32CubeIDE directions
Add directions on using STM32CubeIDE for developing Zephyr.

Signed-off-by: Robert Middleton <robert.middleton@rm5248.com>
2026-04-20 17:56:14 +08:00
Benjamin Cabé c75958bdba doc: sphinx-lint: fix bad usage of "default role"
Fixes bad usage of single backticks in lieu of double backticks for
rendering inline literals, or simple '*' for italics.

When appropriate, a better construct than double backticks has been
selected (ex. :file:, :kconfig:option:, :c:func:, ...), or proper :ref:
have been used if the original intention was to have a link.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-20 17:43:08 +08:00
Benjamin Cabé 603639d126 Revert "doc: develop: tools: Exclude webp images from PDF"
This reverts commit a156b619d4.
Now that Sphinx 7.4 is out, it is possible to use webp images
in the PDF documentation (they're converted to png).

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-20 17:31:31 +08:00
Enguerrand de Ribaucourt a5660e37cc doc: develop: tools: add VS Code setup guide
This basic guide only covers linting so far. It could be expanded in the
future to be more accurate and detailed. The current configuration
allows to navigate the code but some symbols are not recognized by the
linter, and the native compiler is always used.

Co-authored-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Co-authored-by: Luc BEAUFILS <luc.beaufils@savoirfairelinux.com>
Signed-off-by: Enguerrand de Ribaucourt <enguerrand.de-ribaucourt@savoirfairelinux.com>
Signed-off-by: Luc BEAUFILS <luc.beaufils@savoirfairelinux.com>
2026-04-20 17:28:20 +08:00
Benjamin Cabé 8a7950e920 doc: develop: tools: Exclude webp images from PDF
Until Sphinx 7.4.0 is out, it's not possible to use .webp in Latex/PDF
See https://github.com/sphinx-doc/sphinx/pull/12224

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-20 17:25:20 +08:00
Marina Kalashina 902861e217 doc: develop: tools: CLion tutorial
This commit adds a tutorial on how to set up, build, and debug
a sample Zephyr application in CLion.

Signed-off-by: Marina Kalashina <marina.kalashina@jetbrains.com>
Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
2026-04-20 17:07:16 +08:00
Gerard Marull-Paretas 21f04fd189 doc: develop: tools: drop platformio docs
PlatformIO seems to not keep up with Zephyr (they don't seem to even
support 3.0), so we should not recommend it as an IDE as part of our
official docs. Also, it is frequent to see people reporting problems on
our Discord channels.

Ref. https://github.com/platformio/platform-ststm32/issues/602

Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no>
2026-04-20 16:08:43 +08:00
Stephanos Ioannidis d730c5ae74 doc: tools: coccinelle: Update documentation link
This commit updates the oudated link to the Cocinelle documentation.

Signed-off-by: Stephanos Ioannidis <stephanos.ioannidis@nordicsemi.no>
2026-04-20 16:01:34 +08:00
Anas Nashif 0bc3204c6e doc: remove guides and split content
Remove the old guides section and move all remaining items into new
sections.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2026-04-20 15:44:22 +08:00