1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-28 23:49:47 +01:00
Commit Graph

483 Commits

Author SHA1 Message Date
Mikolai Gütschow
a2ef45f252
doc: mention auto_adjust in relevant section of porting-boards.md 2024-11-18 17:41:36 +01:00
Marian Buschsieweke
15086a2f55
Merge pull request #20024 from mguetschow/makefile-subfolders
Build system: support for application subfolders
2024-11-12 08:05:47 +00:00
Mikolai Gütschow
518f75f687
docs: link to subfolders example in documentation
Co-authored-by: plmorange <pierre1.lemeur@orange.com>
2024-11-04 11:15:28 +01:00
krzysztof-cabaj
cbe8333538 boards/nucleo-l433rc: add pinout file 2024-11-01 20:16:16 +01:00
mguetschow
5da0dbe004
Merge pull request #20897 from miri64/doxygen/cleanup/doxyfile
riot.doxyfile: Update and remove deprecated options
2024-10-09 08:07:48 +00:00
Martine Lenders
1a067e177e
riot.doxyfile: Update and remove deprecated options 2024-10-08 13:37:00 +02:00
Mikolai Gütschow
306b8a872b
doc/doxygen: print link to generated documentation 2024-10-08 11:34:38 +02:00
mguetschow
723d8cd47e
Merge pull request #20566 from maribu/buildsystem/document-riotbuild.h
build system: document `riotbuild.h` and deprecated `RIOT_MCU`
2024-10-01 12:57:24 +00:00
Marian Buschsieweke
906e2c3234
build system: document riotbuid.h
This adds a `riotbuild-prefix.h` that is added to the `riotbuild.h`
and processed by Doxygen. It solves two problems:

1. The pre-defined macros where previously fully undocumented, but
   may be useful to real world applications
2. It provides a place where backward compatibility aliases can be
   added with a deprecation notice
2024-09-28 18:32:49 +02:00
benpicco
74ddc4abfb
Merge pull request #20860 from chrysn-pull-requests/update-docker
Update docker image (and document the process)
2024-09-11 09:39:38 +00:00
chrysn
e774040df6 doc: Align c2rust installation with docker image setup 2024-09-11 10:26:29 +02:00
chrysn
ae0c9420b3 doc: Point out common problem installing c2rust 2024-08-29 15:04:49 +02:00
krzysztof-cabaj
f5ad1d5b3e boards/nucleo-g431rb & g474re: add pinouts file 2024-08-22 13:47:02 +02:00
krzysztof-cabaj
b5ac84d689 boards/nucleo-g070rb & g071rb: add pinout file 2024-08-18 13:03:30 +02:00
krzysztof-cabaj
2c112488cc boards/stm32l0538-disco: add pinout file 2024-08-09 11:50:02 +02:00
krzysztof-cabaj
705dc253cb boards/stm32l476g-disco: add pinout file 2024-08-07 10:54:50 +02:00
krzysztof-cabaj
7a1b5c8a9b boards/nucleo-f303ze: add pinout file 2024-05-31 19:36:34 +02:00
krzysztof-cabaj
2b32b4cfa8 boards/nucleo-l496zg: add pinout file 2024-05-29 11:33:38 +02:00
krzysztof-cabaj
1d56f45bc6 boards/nucleo-l4r5zi: add pinout file 2024-05-29 09:33:29 +02:00
Mikolai Gütschow
154e0bd881
doc/doxygen: remove default value for search form 2024-05-21 15:09:19 +02:00
krzysztof-cabaj
96b69136c6 boards/nucleo-l452re: add pinout file 2024-05-16 19:57:01 +02:00
krzysztof-cabaj
06a6990cff boards/c031c6: add pinout file 2024-05-07 15:05:10 +02:00
Marian Buschsieweke
166d3aa928
doc/doxygen: fix sidenav handling
In https://github.com/RIOT-OS/RIOT/pull/20511/files a quick fix was
added to allow resizing the sidenav. But this broke hiding the sidenav
on mobile screen widths. This fixes the issue and also increase the
default sidenav width a tad.
2024-04-27 10:34:07 +02:00
benpicco
34222e1451
Merge pull request #20614 from krzysztof-cabaj/nucleo144-pinouts
boards/nucleo144: add pinout diagrams to boards documentation
2024-04-23 19:57:25 +00:00
benpicco
b1552c5118
Merge pull request #20611 from krzysztof-cabaj/doc-terminal-programs
doc/terminals: add putty and sort terminals
2024-04-23 19:57:11 +00:00
krzysztof-cabaj
b3b342a7d3 boards/nucleo144: add pinout file for f412zg and f413zh 2024-04-23 15:28:17 +02:00
krzysztof-cabaj
b443c70a1d doc/terminals: add to putty TOC link 2024-04-23 12:14:47 +02:00
krzysztof-cabaj
91a8b00dee boards/nucleo144: add pinout file for f207, f429, f439 and f767 2024-04-23 11:10:45 +02:00
krzysztof-cabaj
68c37f653b boards/nucleo144: add pinout file for f446ze and f722ze 2024-04-23 10:33:57 +02:00
krzysztof-cabaj
a51e99d03c doc/terminals: sort terminals alphabetically 2024-04-23 09:16:59 +02:00
krzysztof-cabaj
bea0e38148 doc/terminals: add putty 2024-04-22 16:09:04 +02:00
Mikolai Gütschow
e6fb623947
doc/getting-started: add hint for correct access rights on serial device 2024-04-19 17:31:31 +02:00
Marian Buschsieweke
04620d471c
Merge pull request #20438 from MrKevinWeiss/pr/kconfig/dep/removal
Remove Kconfig dependency modelling
2024-03-27 16:39:56 +00:00
MrKevinWeiss
d265330a26
kconfig.md: Update kconfig doc with removed deps 2024-03-27 10:28:15 +01:00
Remmirad
084c42c2a9 doc: Allow resizing of side-nav
Currently it is not possible to resize the side-nav of the RIOT doxygen website in firefox.
This is caused by the window resize_handler being called even for resizing inside the window.
The resize_handler resets the side-nav to a cached size preventing resizing. This commit fixes
this by checking if the window was actually resized.
2024-03-27 09:31:05 +01:00
Marian Buschsieweke
285b99c87e
Merge pull request #20493 from OlegHahm/pr/doxygen/add_term_config
doc: add terminal program configuration
2024-03-26 15:41:59 +00:00
Karl Fessel
20decc9cfe
Merge pull request #20498 from miri64/doc/enh/vision-graphic
doc: add graphic to vision page
2024-03-26 15:31:38 +00:00
Karl Fessel
7b1ed57513
Merge pull request #20506 from maribu/doc/doxygen-menu/fix-name-of-modules-category
doc/doxygen: fix name and intro of "Modules" section
2024-03-26 15:30:52 +00:00
benpicco
53497750c5
Merge pull request #19709 from benpicco/appendectomy
rdm/radio_hal: remove appendix A
2024-03-26 15:03:36 +00:00
Marian Buschsieweke
5a966fb08a
doc/doxygen: fix name and intro of "Modules" section
This fixes a regression from https://github.com/RIOT-OS/RIOT/pull/20443
which does cause the modules to re-appear in the side panel, but under
the name "Topics" rather than "Modules".
2024-03-26 13:23:43 +01:00
Marian Buschsieweke
6844ba2a0c
doc/community-process: improve markdown style
This contains minor changes to ease maintaining the document (e.g.
by using reference-style links so that an URL needs to be updated
only in a single place) and adds explicit anchors to ease linking to
a certain section.
2024-03-26 10:35:33 +01:00
Martine Lenders
0dc04f6222
doc: add graphic to vision page 2024-03-22 16:07:59 +01:00
Emmanuel Baccelli
fd2a79d650 doxygen: added community processes (import from Wiki) 2024-03-21 11:44:18 +01:00
Oleg Hahm
a21de1bcd3 doc: add terminal program configuration 2024-03-21 10:54:24 +01:00
Emmanuel Baccelli
ec0aaf9068 doxygen: added vision.md imported from wiki 2024-03-20 11:25:33 +01:00
Teufelchen1
a62d77dd77 rdm/radio_hal: remove appendix A, deprecating RDM0002 via RDM0004 2024-03-19 18:17:04 +01:00
Marian Buschsieweke
dc901b0e62
doc/doxygen/src/getting-started.md: fix broken link 2024-03-19 12:54:50 +01:00
Emmanuel Baccelli
d17d315377 rdm/README: add rdm0003 to the list 2024-03-14 14:55:15 +01:00
Marian Buschsieweke
37269c8ec7
Merge pull request #20442 from maribu/fuck-xitter
doc: replace obsolete xitter link with mastodon link
2024-03-01 11:51:56 +00:00
Oleg Hahm
cc14954c57 doc: doxygen: add "Topics" to menus
Beginning with doxygen 1.9.8 "Modules" are renamed to "Topics". This
patch adds the new entry to the layout file. Having both, "Modules" and
"Topics" in the layout file should generate similar output for older and
newer doxygen versions.
2024-03-01 12:15:24 +01:00