[llvm-branch-commits] [clang-tools-extra] [clang-doc] Add a "Home" link to navbar (PR #171900)

[Erick Velez via llvm-branch-commits]

https://github.com/evelez7 updated https://github.com/llvm/llvm-project/pull/171900

>From 320d1f49f291e4cf147f86b95a48785a7f922352 Mon Sep 17 00:00:00 2001
From: Erick Velez <erickvelez7 at gmail.com>
Date: Tue, 9 Dec 2025 09:41:28 -0800
Subject: [PATCH] [clang-doc] Add a "Home" link to navbar

This patch removes the old buttons and adds a link to the homepage.
---
 clang-tools-extra/clang-doc/HTMLGenerator.cpp |  7 +++++++
 .../clang-doc/assets/navbar-template.mustache |  5 +----
 .../clang-doc/basic-project.mustache.test     | 20 ++++---------------
 3 files changed, 12 insertions(+), 20 deletions(-)

diff --git a/clang-tools-extra/clang-doc/HTMLGenerator.cpp b/clang-tools-extra/clang-doc/HTMLGenerator.cpp
index 3fc89311749ad..1af555a5b772b 100644
--- a/clang-tools-extra/clang-doc/HTMLGenerator.cpp
+++ b/clang-tools-extra/clang-doc/HTMLGenerator.cpp
@@ -120,6 +120,13 @@ Error HTMLGenerator::setupTemplateResources(const ClangDocContext &CDCtx,
     SCA->emplace_back(JsPath);
   }
   V.getAsObject()->insert({"Scripts", ScriptArr});
+  if (RelativeRootPath.empty()) {
+    RelativeRootPath = "";
+  } else {
+    sys::path::append(RelativeRootPath, "/index.html");
+    sys::path::native(RelativeRootPath, sys::path::Style::posix);
+  }
+  V.getAsObject()->insert({"Homepage", RelativeRootPath});
   return Error::success();
 }
 
diff --git a/clang-tools-extra/clang-doc/assets/navbar-template.mustache b/clang-tools-extra/clang-doc/assets/navbar-template.mustache
index 178d147a556d3..2767d5af86668 100644
--- a/clang-tools-extra/clang-doc/assets/navbar-template.mustache
+++ b/clang-tools-extra/clang-doc/assets/navbar-template.mustache
@@ -8,10 +8,7 @@
         <div class="navbar__menu">
             <ul class="navbar__links">
                 <li class="navbar__item">
-                    <a href="/" class="navbar__link">Namespace</a>
-                </li>
-                <li class="navbar__item">
-                    <a href="/" class="navbar__link">Class</a>
+                    <a href="{{Homepage}}" class="navbar__link">Home</a>
                 </li>
             </ul>
         </div>
diff --git a/clang-tools-extra/test/clang-doc/basic-project.mustache.test b/clang-tools-extra/test/clang-doc/basic-project.mustache.test
index d406c9f297960..26e42280f3474 100644
--- a/clang-tools-extra/test/clang-doc/basic-project.mustache.test
+++ b/clang-tools-extra/test/clang-doc/basic-project.mustache.test
@@ -25,10 +25,7 @@ HTML-SHAPE:             </div>
 HTML-SHAPE:         <div class="navbar__menu">
 HTML-SHAPE:             <ul class="navbar__links">
 HTML-SHAPE:                 <li class="navbar__item">
-HTML-SHAPE:                     <a href="/" class="navbar__link">Namespace</a>
-HTML-SHAPE:                 </li>
-HTML-SHAPE:                 <li class="navbar__item">
-HTML-SHAPE:                     <a href="/" class="navbar__link">Class</a>
+HTML-SHAPE:                     <a href="../index.html" class="navbar__link">Home</a>
 HTML-SHAPE:                 </li>
 HTML-SHAPE:             </ul>
 HTML-SHAPE:         </div>
@@ -135,10 +132,7 @@ HTML-CALC:             </div>
 HTML-CALC:         <div class="navbar__menu">
 HTML-CALC:             <ul class="navbar__links">
 HTML-CALC:                 <li class="navbar__item">
-HTML-CALC:                     <a href="/" class="navbar__link">Namespace</a>
-HTML-CALC:                 </li>
-HTML-CALC:                 <li class="navbar__item">
-HTML-CALC:                     <a href="/" class="navbar__link">Class</a>
+HTML-CALC:                     <a href="../index.html" class="navbar__link">Home</a>
 HTML-CALC:                 </li>
 HTML-CALC:             </ul>
 HTML-CALC:         </div>
@@ -339,10 +333,7 @@ HTML-RECTANGLE:             </div>
 HTML-RECTANGLE:         <div class="navbar__menu">
 HTML-RECTANGLE:             <ul class="navbar__links">
 HTML-RECTANGLE:                 <li class="navbar__item">
-HTML-RECTANGLE:                     <a href="/" class="navbar__link">Namespace</a>
-HTML-RECTANGLE:                 </li>
-HTML-RECTANGLE:                 <li class="navbar__item">
-HTML-RECTANGLE:                     <a href="/" class="navbar__link">Class</a>
+HTML-RECTANGLE:                     <a href="../index.html" class="navbar__link">Home</a>
 HTML-RECTANGLE:                 </li>
 HTML-RECTANGLE:             </ul>
 HTML-RECTANGLE:         </div>
@@ -457,10 +448,7 @@ HTML-CIRCLE:             </div>
 HTML-CIRCLE:         <div class="navbar__menu">
 HTML-CIRCLE:             <ul class="navbar__links">
 HTML-CIRCLE:                 <li class="navbar__item">
-HTML-CIRCLE:                     <a href="/" class="navbar__link">Namespace</a>
-HTML-CIRCLE:                 </li>
-HTML-CIRCLE:                 <li class="navbar__item">
-HTML-CIRCLE:                     <a href="/" class="navbar__link">Class</a>
+HTML-CIRCLE:                     <a href="../index.html" class="navbar__link">Home</a>
 HTML-CIRCLE:                 </li>
 HTML-CIRCLE:             </ul>
 HTML-CIRCLE:         </div>