llvmbot wrote:
<!--LLVM PR SUMMARY COMMENT--> @llvm/pr-subscribers-clang-tools-extra Author: Erick Velez (evelez7) <details> <summary>Changes</summary> Move navbar section to its own template to ensure consistency across templates --- Full diff: https://github.com/llvm/llvm-project/pull/171669.diff 6 Files Affected: - (modified) clang-tools-extra/clang-doc/HTMLGenerator.cpp (+4-1) - (modified) clang-tools-extra/clang-doc/assets/class-template.mustache (+1-19) - (modified) clang-tools-extra/clang-doc/assets/namespace-template.mustache (+1-19) - (added) clang-tools-extra/clang-doc/assets/navbar-template.mustache (+19) - (modified) clang-tools-extra/clang-doc/support/Utils.cpp (+3) - (modified) clang-tools-extra/clang-doc/tool/CMakeLists.txt (+1) ``````````diff diff --git a/clang-tools-extra/clang-doc/HTMLGenerator.cpp b/clang-tools-extra/clang-doc/HTMLGenerator.cpp index 19018f2cf845d..77b287476423e 100644 --- a/clang-tools-extra/clang-doc/HTMLGenerator.cpp +++ b/clang-tools-extra/clang-doc/HTMLGenerator.cpp @@ -68,11 +68,14 @@ Error HTMLGenerator::setupTemplateFiles(const ClangDocContext &CDCtx) { ConvertToNative(CDCtx.MustacheTemplates.lookup("enum-template")); std::string HeadFilePath = ConvertToNative(CDCtx.MustacheTemplates.lookup("head-template")); + std::string NavbarFilePath = + ConvertToNative(CDCtx.MustacheTemplates.lookup("navbar-template")); std::vector<std::pair<StringRef, StringRef>> Partials = { {"Comments", CommentFilePath}, {"FunctionPartial", FunctionFilePath}, {"EnumPartial", EnumFilePath}, - {"HeadPartial", HeadFilePath}}; + {"HeadPartial", HeadFilePath}, + {"NavbarPartial", NavbarFilePath}}; if (Error Err = setupTemplate(NamespaceTemplate, NamespaceFilePath, Partials)) return Err; diff --git a/clang-tools-extra/clang-doc/assets/class-template.mustache b/clang-tools-extra/clang-doc/assets/class-template.mustache index 9c5019510b43c..fcd923cd9db93 100644 --- a/clang-tools-extra/clang-doc/assets/class-template.mustache +++ b/clang-tools-extra/clang-doc/assets/class-template.mustache @@ -9,25 +9,7 @@ <html lang="en-US"> {{>HeadPartial}} <body> - <nav class="navbar"> - <div class="navbar__container"> - {{#ProjectName}} - <div class="navbar__logo"> - {{ProjectName}} - </div> - {{/ProjectName}} - <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> - </li> - </ul> - </div> - </div> - </nav> + {{>NavbarPartial}} <main> <div class="container"> <div class="sidebar"> diff --git a/clang-tools-extra/clang-doc/assets/namespace-template.mustache b/clang-tools-extra/clang-doc/assets/namespace-template.mustache index f386eb2e6a581..5c0d2fb14d3c9 100644 --- a/clang-tools-extra/clang-doc/assets/namespace-template.mustache +++ b/clang-tools-extra/clang-doc/assets/namespace-template.mustache @@ -9,25 +9,7 @@ <html lang="en-US"> {{>HeadPartial}} <body> - <nav class="navbar"> - <div class="navbar__container"> - {{#ProjectName}} - <div class="navbar__logo"> - {{ProjectName}} - </div> - {{/ProjectName}} - <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> - </li> - </ul> - </div> - </div> - </nav> + {{>NavbarPartial}} <main> <div class="container"> <div class="sidebar"> diff --git a/clang-tools-extra/clang-doc/assets/navbar-template.mustache b/clang-tools-extra/clang-doc/assets/navbar-template.mustache new file mode 100644 index 0000000000000..178d147a556d3 --- /dev/null +++ b/clang-tools-extra/clang-doc/assets/navbar-template.mustache @@ -0,0 +1,19 @@ +<nav class="navbar"> + <div class="navbar__container"> + {{#ProjectName}} + <div class="navbar__logo"> + {{ProjectName}} + </div> + {{/ProjectName}} + <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> + </li> + </ul> + </div> + </div> +</nav> diff --git a/clang-tools-extra/clang-doc/support/Utils.cpp b/clang-tools-extra/clang-doc/support/Utils.cpp index 50e849dc26c79..d0fd6f45b8a02 100644 --- a/clang-tools-extra/clang-doc/support/Utils.cpp +++ b/clang-tools-extra/clang-doc/support/Utils.cpp @@ -58,6 +58,8 @@ void getHtmlFiles(StringRef AssetsPath, clang::doc::ClangDocContext &CDCtx) { appendPathPosix(AssetsPath, "comment-template.mustache"); SmallString<128> HeadTemplate = appendPathPosix(AssetsPath, "head-template.mustache"); + SmallString<128> NavbarTemplate = + appendPathPosix(AssetsPath, "navbar-template.mustache"); CDCtx.MustacheTemplates.insert( {"namespace-template", NamespaceTemplate.c_str()}); @@ -67,4 +69,5 @@ void getHtmlFiles(StringRef AssetsPath, clang::doc::ClangDocContext &CDCtx) { {"function-template", FunctionTemplate.c_str()}); CDCtx.MustacheTemplates.insert({"comment-template", CommentTemplate.c_str()}); CDCtx.MustacheTemplates.insert({"head-template", HeadTemplate.c_str()}); + CDCtx.MustacheTemplates.insert({"navbar-template", NavbarTemplate.c_str()}); } diff --git a/clang-tools-extra/clang-doc/tool/CMakeLists.txt b/clang-tools-extra/clang-doc/tool/CMakeLists.txt index eb8f937bae831..c8b4162a0e716 100644 --- a/clang-tools-extra/clang-doc/tool/CMakeLists.txt +++ b/clang-tools-extra/clang-doc/tool/CMakeLists.txt @@ -32,6 +32,7 @@ set(assets namespace-template.mustache template.mustache head-template.mustache + navbar-template.mustache ) set(asset_dir "${CMAKE_CURRENT_SOURCE_DIR}/../assets") `````````` </details> https://github.com/llvm/llvm-project/pull/171669 _______________________________________________ llvm-branch-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-branch-commits
