doc: scripts: gen_devicetree_rest: add link to board catalog in sidebar

kartben · LingaoM · commit 2e94b80307f5 · 2025-10-23T09:31:54.000+08:00
This adds a link to the board catalog in the sidebar of each binding
page, directing users to boards using the compatible.

Signed-off-by: Benjamin Cabé &lt;benjamin@zephyrproject.org&gt;
diff --git a/doc/_scripts/gen_devicetree_rest.py b/doc/_scripts/gen_devicetree_rest.py
@@ -505,6 +505,8 @@ def make_sidebar(compatible, vendor_name, vendor_ref_target, driver_path=None):
         "",
         f"   :Name: ``{compatible}``",
         f"   :Vendor: :ref:`{vendor_name} <{vendor_ref_target}>`",
+        f"   :Used in: :zephyr:board-catalog:`List of boards <#compatibles={compatible}>` using",
+        "               this compatible",
     ]
     if driver_path:
         lines.append(f"   :Driver: :zephyr_file:`{driver_path}`")

Original file line number	Diff line number	Diff line change
`@@ -505,6 +505,8 @@ def make_sidebar(compatible, vendor_name, vendor_ref_target, driver_path=None):`
`505`	`505`	`"",`
`506`	`506`	f" :Name: ``{compatible}``",
`507`	`507`	f" :Vendor: :ref:`{vendor_name} <{vendor_ref_target}>`",
	`508`	+ f" :Used in: :zephyr:board-catalog:`List of boards <#compatibles={compatible}>` using",
	`509`	`+ " this compatible",`
`508`	`510`	`]`
`509`	`511`	`if driver_path:`
`510`	`512`	lines.append(f" :Driver: :zephyr_file:`{driver_path}`")