diff options
author | vladmos <vladmos@google.com> | 2018-08-01 09:42:55 -0700 |
---|---|---|
committer | Copybara-Service <copybara-piper@google.com> | 2018-08-01 09:44:25 -0700 |
commit | bf68cda03d8efc697aedb13e75d0511fe5297f2b (patch) | |
tree | fb15f9a3bd1c6ee521eb998e157e7a93cd255ba9 | |
parent | f8afad6f22786ba646cbd10a73e5738884cc84b8 (diff) |
Fix a broken link in the documentation
Fixes #5601
PiperOrigin-RevId: 206942639
3 files changed, 4 insertions, 2 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java index deed2ce679..a8c7c68948 100644 --- a/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java +++ b/src/main/java/com/google/devtools/build/docgen/SkylarkDocumentationProcessor.java @@ -14,6 +14,7 @@ package com.google.devtools.build.docgen; import com.google.common.collect.ImmutableList; +import com.google.devtools.build.docgen.skylark.SkylarkDocUtils; import com.google.devtools.build.docgen.skylark.SkylarkMethodDoc; import com.google.devtools.build.docgen.skylark.SkylarkModuleDoc; import com.google.devtools.build.lib.skylarkinterface.SkylarkModuleCategory; @@ -138,6 +139,7 @@ public final class SkylarkDocumentationProcessor { Page page = TemplateEngine.newPage(DocgenConsts.SKYLARK_MODULE_CATEGORY_TEMPLATE); page.add("category", category); page.add("modules", modules.get(category)); + page.add("description", SkylarkDocUtils.substituteVariables(category.getDescription())); page.write(skylarkDocPath); } diff --git a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java index 18300683af..27f66a52ef 100644 --- a/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java +++ b/src/main/java/com/google/devtools/build/docgen/skylark/SkylarkDocUtils.java @@ -27,7 +27,7 @@ public final class SkylarkDocUtils { * * @return a string with substituted variables */ - static String substituteVariables(String documentation) { + public static String substituteVariables(String documentation) { return documentation .replace("$BE_ROOT", DocgenConsts.BeDocsRoot) .replace("$DOC_EXT", DocgenConsts.documentationExtension); diff --git a/src/main/java/com/google/devtools/build/docgen/templates/skylark-category.vm b/src/main/java/com/google/devtools/build/docgen/templates/skylark-category.vm index 64646d4dd4..ae302f3d1f 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/skylark-category.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/skylark-category.vm @@ -4,7 +4,7 @@ title: ${category.title} --- <h1>${category.title}</h1> -${category.description} +${description} <div class="toc"> <ul> |