crasbe
64898cf13a
doc/doxygen: Add a check for the GraphViz dependency
2025-04-04 17:59:53 +02:00
crasbe
9cd4964024
dist/tools: add doxygen as a tool for CI
2025-04-04 17:59:53 +02:00
Marian Buschsieweke
ea5df2ef7e
Merge pull request #20980 from mguetschow/board-xiao-nrf52840
...
boards/seeedstudio-xiao-nrf52840: initial board support
2025-03-12 11:52:50 +00:00
Mikolai Gütschow
a0678a7a55
boards/seeedstudio-xiao-nrf52840: Arduino pin map
2025-03-12 12:39:56 +01:00
mguetschow
8dae0df592
Merge pull request #21274 from crasbe/pr/fix_doxygen_logo
...
doc: Use the correct Doxygen Logo File Type in the Footer
2025-03-10 13:19:27 +00:00
crasbe
26573944c6
doc: use the correct logo file type in the footer
2025-03-10 13:13:39 +01:00
Marian Buschsieweke
2f1788c6c3
Merge pull request #21277 from crasbe/pr/doxygen_versioncheck
...
doc, buildsystem: Add a Version Check for Doxygen, Fix doc* Target Execution
2025-03-07 20:12:47 +00:00
crasbe
b7147af59a
doc: add a version check for Doxygen
2025-03-07 20:18:41 +01:00
Mikolai Gütschow
67f3d79761
doc: hack to hide doc.md files until doxygen gets fixed
...
Co-Authored-By: carl-tud <115627588+carl-tud@users.noreply.github.com>
2025-03-06 14:53:19 +01:00
mguetschow
e545642ef1
Merge pull request #21257 from crasbe/pr/porting_boards_new
...
doc/porting-boards: Change example doc.txt to doc.md
2025-03-03 13:04:19 +00:00
crasbe
cb0c45baf4
doc/porting-boards: change example doc.txt to doc.md
2025-03-03 13:25:30 +01:00
Karl Fessel
55fb450e47
doc: doc.txt -> doc.md
2025-02-28 18:37:03 +01:00
mguetschow
dcdf6a2df2
Merge pull request #21236 from chrysn-pull-requests/doc-c2rust-locked
...
docs/rust: Install c2rust with --locked
2025-02-21 13:41:24 +00:00
chrysn
31c45477e8
docs/rust: Install c2rust with --locked
...
Closes: https://github.com/RIOT-OS/RIOT/issues/21079
2025-02-21 14:27:09 +01:00
Mikolai Gütschow
9a45c30222
examples: shorten subfolders' names
2025-02-21 09:55:24 +01:00
Mikolai Gütschow
ca5fe72bf8
treewide: fix example references in docs
...
adapt to folder structure from #21135
2025-02-14 19:14:22 +01:00
Martine Lenders
9e1437910f
doc: add documentation on RIOT_FILE_RELATIVE
2025-01-28 20:42:41 +01:00
Martine Lenders
035ad08b3f
GOVERNANCE.md: remove “Community Processes” in favor of “GOVERNANCE.md”
...
Co-Authored-By: Matthias Waehlisch <waehlisch@ieee.org>
Co-Authored-By: mguetschow <mikolai.guetschow@tu-dresden.de>
Co-Authored-By: Emmanuel Baccelli <emmanuel.baccelli@inria.fr>
Co-Authored-By: jkarinkl <134642460+jkarinkl@users.noreply.github.com>
Co-Authored-By: Karl Fessel <karl.fessel@gmail.com>
2025-01-20 14:01:32 +01:00
Martine Lenders
e8feb438cc
doxygen/Makefile: fix make latex and make clean
2024-12-16 14:06:12 +01:00
Martine Lenders
234b81bf8a
Merge pull request #21071 from miri64/doc/enh/coc
...
doc: Improvements around Code of Conduct
2024-12-16 12:54:32 +00:00
Martine Lenders
e96211f0c9
coc-faq.md: Enforce 80 column formatting.
...
Co-authored-by: Marian Buschsieweke <maribu@users.noreply.github.com>
2024-12-16 13:14:42 +01:00
Martine Lenders
544ae78f6f
coc-faq.md: update to current state
...
Co-authored-by: mguetschow <mikolai.guetschow@tu-dresden.de>
2024-12-16 13:10:40 +01:00
Martine Lenders
721f5189d4
doc: fix CoC reporting guidelines formatting for Doxygen
2024-12-10 16:37:25 +01:00
Martine Lenders
496b145f80
doc: bend CoC-related links to proper places
2024-12-10 16:05:56 +01:00
Martine Lenders
6bca56bb67
doc: add CoC information to documentation
2024-12-10 16:02:23 +01:00
Martine Lenders
a5a942b1fb
doc: move CoC FAQ from wiki
...
See also https://github.com/RIOT-OS/RIOT/wiki/CoC:-FAQ/_history
2024-12-10 16:01:21 +01:00
Martine Lenders
ab1ca9c80b
doc: move CoC reporting guidelines from wiki
...
See also https://github.com/RIOT-OS/RIOT/wiki/CoC:-Reporting-Guidelines/_history
2024-12-10 16:00:50 +01:00
Martine Lenders
2b5dea04d3
MAINTAINING.md: point to new auto-generated maintainer list
2024-12-09 15:39:34 +01:00
Martine Lenders
cb5500b4b7
Merge pull request #21066 from miri64/doc/enh/maintaining-updates
...
MAINTAINING.md/doc: move links from wiki to doc
2024-12-06 15:35:27 +00:00
Martine Lenders
7faa477a55
doc: add maintainers list
...
This is just the generated result from #21062 while that PR is under
development
2024-12-06 15:16:33 +01:00
Martine Lenders
bbbe4c0353
doc/dev-best-practices: fix some links and add table of contents
2024-12-06 13:49:44 +01:00
Martine Lenders
223136a15f
doc/static-vs-dynamic-memory: move to dev-best-practices
2024-12-06 13:49:44 +01:00
Martine Lenders
f762232a12
doc/static-vs-dynamic-memory: style and spelling fixes + updates
...
To current status quo.
2024-12-06 13:49:44 +01:00
Martine Lenders
314b3374c6
doc/compare-build-sizes: move to “Advanced build system tricks”
2024-12-06 13:49:43 +01:00
Martine Lenders
1b86fe3ea1
doc/ccache: move to “Advanced build system tricks”
2024-12-06 13:49:42 +01:00
Martine Lenders
113b5c55e3
doc/ccache: fix spelling and syntax for doxygen
2024-12-06 13:49:31 +01:00
Martine Lenders
7f1e315f85
doc: dump wiki pages linked in MAINTAINING.md to doc
2024-12-06 12:49:53 +01:00
Martine Lenders
c99e8da679
doc: move "managing a release" from wiki
2024-12-06 11:28:50 +01:00
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
