doc: _extensions: show boards as maintained/not actively maintained in docs

This uses the MAINTAINERS file to determine if a board is maintained or
not, stores the information in the catalog and shows this in the "wikipedia
sidebar" of the board documentation (adding filtering based on this is a
future enhancement opportunity).

Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>

Author: kartben

doc/_extensions/zephyr/domain/__init__.py

@@ -299,9 +299,23 @@ def convert_node(self, node):
             field_list = nodes.field_list()
             sidebar += field_list
 
+            if node.get("maintained", False):
+                status_text = nodes.abbreviation(
+                    "Maintained",
+                    "Maintained",
+                    explanation="At least one active maintainer is looking after this board",
+                )
+            else:
+                status_text = nodes.abbreviation(
+                    "Not actively maintained",
+                    "Not actively maintained",
+                    explanation="No active maintainer on file, but contributions are welcome",
+                )
+
             details = [
                 ("Name", nodes.literal(text=node["id"])),
                 ("Vendor", node["vendor"]),
+                ("Status", status_text),
                 ("Architecture", ", ".join(node["archs"])),
                 ("SoC", ", ".join(node["socs"])),
             ]
@@ -744,6 +758,7 @@ def run(self):
             board_node["supported_runners"] = board["supported_runners"]
             board_node["flash_runner"] = board["flash_runner"]
             board_node["debug_runner"] = board["debug_runner"]
+            board_node["maintained"] = board.get("maintained", False)
             return [board_node]
 
 

doc/_extensions/zephyr/domain/templates/board-card.html

@@ -37,6 +37,7 @@
     {%- endfor -%}
     {{- all_compatibles|join(' ') -}}
   "
+  data-maintained="{{ board.maintained | tojson }}"
   tabindex="0">
   <div class="vendor">{{ vendors[board.vendor] }}</div>
   {% if board.image -%}

doc/_scripts/gen_boards_catalog.py

@@ -16,6 +16,7 @@
 import yaml
 import zephyr_module
 from gen_devicetree_rest import VndLookup
+from get_maintainer import Maintainers
 from runners.core import ZephyrBinaryRunner
 
 ZEPHYR_BASE = Path(__file__).parents[2]
@@ -31,6 +32,31 @@
 
 logger = logging.getLogger(__name__)
 
+# Initialize the Maintainers object for looking up board maintenance status
+MAINTAINERS = Maintainers(filename=ZEPHYR_BASE / "MAINTAINERS.yml")
+
+
+def is_board_maintained(board_doc_path: Path) -> bool:
+    """Determine if a board is actively maintained based on whether it is covered by an area with
+    status 'maintained' in the MAINTAINERS.yml file.
+
+    Args:
+        board_doc_path: A board doc path relative to ZEPHYR_BASE.
+
+    Returns:
+        True if the board is covered by an area with status 'maintained', False otherwise.
+    """
+
+    # path2areas needs os.getcwd() to be set to ZEPHYR_BASE
+    original_cwd = os.getcwd()
+    try:
+        os.chdir(ZEPHYR_BASE)
+        areas = MAINTAINERS.path2areas(board_doc_path)
+    finally:
+        os.chdir(original_cwd)
+
+    return any(area.status == "maintained" for area in areas)
+
 
 class DeviceTreeUtils:
     _compat_description_cache = {}
@@ -399,6 +425,7 @@ def get_catalog(generate_hw_features=False, hw_features_vendor_filter=None):
             "supported_features": supported_features,
             "compatibles": compatibles,
             "image": guess_image(board),
+            "maintained": is_board_maintained(doc_page_path) if doc_page_path else False,
             # runners
             "supported_runners": board_runner_info.get("runners", []),
             "flash_runner": board_runner_info.get("flash-runner", ""),