michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: Issue warning for dangling code-sample references

Browse source 
Sphinx will now issue a warning when a code-sample role points to a
sample that does not exist.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2023-09-20 11:54:23 +02:00 • committed by Fabio Baltieri
commit c82d023248
1 changed files with 1 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/_extensions/zephyr/domain.py
View file

@ -214,7 +214,7 @@ class ZephyrDomain(Domain):
label = "Zephyr Project"
roles = {
"code-sample": XRefRole(innernodeclass=nodes.inline),
"code-sample": XRefRole(innernodeclass=nodes.inline, warn_dangling=True),
}
directives = {"code-sample": CodeSampleDirective}