michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: boards: exensions: add board name to side box

Browse source 
This adds the board name (displayed as a code literal) to the "Wikipedia
card" for quick reference.

Fixes #81652.

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
This commit is contained in:
Benjamin Cabé 2024-11-22 12:19:01 +01:00 • committed by Anas Nashif
commit 8ab2802570
2 changed files with 12 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/_extensions/zephyr/domain/__init__.py
View file

@ -253,6 +253,7 @@ class ConvertBoardNode(SphinxTransform):
sidebar += field_list
details = [
("Name", nodes.literal(text=node["id"])),
("Vendor", node["vendor"]),
("Architecture", ", ".join(node["archs"])),
("SoC", ", ".join(node["socs"])),
@ -262,7 +263,10 @@ class ConvertBoardNode(SphinxTransform):
field = nodes.field()
field_name = nodes.field_name(text=property_name)
field_body = nodes.field_body()
field_body += nodes.paragraph(text=value)
if isinstance(value, nodes.Node):
field_body += value
else:
field_body += nodes.paragraph(text=value)
field += field_name
field += field_body
field_list += field

7
doc/_static/css/custom.css vendored
View file

@ -1159,8 +1159,15 @@ li>a.code-sample-link.reference.internal.current {
margin-top: 12px !important;
margin-bottom: 12px !important;
grid-template-columns: auto 1fr !important;
padding-right: 1em;
}
.sidebar.board-overview dl.field-list > dt {
background: transparent !important;
}
.sidebar.board-overview dl.field-list>dd {
margin-left: 1em;
text-overflow: ellipsis;
overflow: hidden;
}