kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-14 17:13:50 +01:00
Code Releases Activity

doc/doxygen: include *.doc.md

Browse Source
This commit is contained in:
Karl Fessel 2025-03-17 12:40:43 +01:00
parent 04a169867e
commit b78bb2322c
4 changed files with 12 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
dist/tools/doccheck/check.sh vendored
View File

@ -73,8 +73,8 @@ exclude_filter() {
# Check groups are correctly defined (e.g. no undefined groups and no group
# defined multiple times)
ALL_RAW_DEFGROUP=$(git grep -n @defgroup -- '*.h' '*.hpp' '*.txt' '*/doc.md' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
ALL_RAW_INGROUP=$(git grep -n '@ingroup' -- '*.h' '*.hpp' '*.txt' '*/doc.md' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
ALL_RAW_DEFGROUP=$(git grep -n '@defgroup' -- '*.h' '*.hpp' '*.txt' '*/doc.md' '*.doc.md' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
ALL_RAW_INGROUP=$(git grep -n '@ingroup' -- '*.h' '*.hpp' '*.txt' '*/doc.md' '*.doc.md' 'makefiles/pseudomodules.inc.mk' 'sys/net/gnrc/routing/ipv6_auto_subnets/gnrc_ipv6_auto_subnets.c'| exclude_filter)
DEFINED_GROUPS=$(echo "${ALL_RAW_DEFGROUP}" | \
grep -oE '@defgroup[ ]+[^ ]+' | \
grep -oE '[^ ]+$' | \

1
doc/doxygen/riot.doxyfile
View File

@ -928,6 +928,7 @@ INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.txt \
doc.md \
*.doc.md \
*.h \
*.h.in \
*.hpp

2
doc/doxygen/src/css/riot.css
View File

@ -522,7 +522,7 @@ table.retval > tbody > tr > td.paramname {
blockquote {
background-color: #eadde1;
}
/* HACK: doc.md files are processed correctly, but additionally add an empty page,
/* HACK: *doc.md files are processed correctly, but additionally add an empty page,
* see https://github.com/doxygen/doxygen/issues/9437
* and https://github.com/RIOT-OS/RIOT/issues/21220#issuecomment-2701284183
* can be removed as soon as the doxygen issue is fixed */

8
doc/doxygen/src/css/riot.less
View File

@ -464,3 +464,11 @@ table.retval > tbody > tr > td.paramname {
blockquote {
background-color: #eadde1;
}
/* HACK: *doc.md files are processed correctly, but additionally add an empty page,
* see https://github.com/doxygen/doxygen/issues/9437
* and https://github.com/RIOT-OS/RIOT/issues/21220#issuecomment-2701284183
* can be removed as soon as the doxygen issue is fixed */
li:has(> .item a[class^="md_"][class$="doc.html"]),
tr:has(> .entry a[href^="md_"][href$="doc.html"]) {
display: none;
}