From 2fc8f97bf66a3b12dd751d265640b6b5494b2a7b Mon Sep 17 00:00:00 2001
From: David Chen <dzc@google.com>
Date: Wed, 17 Feb 2016 08:44:33 +0000
Subject: Do not generate documentation for rule family if it does not contain
 any documented rules.

Currently, we are generating an empty page for the Protocol Buffer rules on
bazel.io because the rule definition exists but all the rules are set as
undocumented. In cases like these, the docgen should neither generate a page
nor any links for the rule family.

Fixes #882

--
MOS_MIGRATED_REVID=114834947
---
 .../devtools/build/docgen/templates/be/be-nav.vm   |  2 +
 .../devtools/build/docgen/templates/be/overview.vm | 86 +++++++++++-----------
 2 files changed, 46 insertions(+), 42 deletions(-)

(limited to 'src/main/java/com/google/devtools/build/docgen/templates/be')

diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/be-nav.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/be-nav.vm
index 44b05953c5..e67487d695 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/be/be-nav.vm
+++ b/src/main/java/com/google/devtools/build/docgen/templates/be/be-nav.vm
@@ -17,7 +17,9 @@
   <li class="sidebar-nav-heading">Built-in Rules</li>
   <li><a href="${path}/functions.html">Functions</a></li>
 #foreach ($ruleFamily in $ruleFamilies)
+  #if ($ruleFamily.size() > 0)
   <li><a href="${path}/${ruleFamily.id}.html">${ruleFamily.name}</a></li>
+  #end
 #end
 
   <li class="sidebar-nav-heading">Skylark Rules</li>
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/overview.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/overview.vm
index 33b24fb33f..a6c0e50af2 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/be/overview.vm
+++ b/src/main/java/com/google/devtools/build/docgen/templates/be/overview.vm
@@ -55,49 +55,51 @@ title: Build Encyclopedia
 #macro(summaryTable $ruleFamilies)
   <tbody>
   #foreach($ruleFamily in $ruleFamilies)
-    <tr>
-      <td class="lang">${ruleFamily.name}</td>
-      <td>
-    #foreach($ruleDoc in $ruleFamily.binaryRules)
-      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
-          ${ruleDoc.ruleName}
-        </a>
-        <br />
-    #end
-      </td>
-      <td>
-    #foreach($ruleDoc in $ruleFamily.libraryRules)
-      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
-          ${ruleDoc.ruleName}
-        </a>
-        <br />
-    #end
-      </td>
-      <td>
-    #foreach($ruleDoc in $ruleFamily.testRules)
-      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
-          ${ruleDoc.ruleName}
-        </a>
-        <br />
+    #if($ruleFamily.size() > 0)
+      <tr>
+        <td class="lang">${ruleFamily.name}</td>
+        <td>
+      #foreach($ruleDoc in $ruleFamily.binaryRules)
+        <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
+            ${ruleDoc.ruleName}
+          </a>
+          <br />
+      #end
+        </td>
+        <td>
+      #foreach($ruleDoc in $ruleFamily.libraryRules)
+        <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
+            ${ruleDoc.ruleName}
+          </a>
+          <br />
+      #end
+        </td>
+        <td>
+      #foreach($ruleDoc in $ruleFamily.testRules)
+        <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
+            ${ruleDoc.ruleName}
+          </a>
+          <br />
+      #end
+        </td>
+        <td>
+      #foreach($ruleDoc in $ruleFamily.otherRules1)
+        <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
+            ${ruleDoc.ruleName}
+          </a>
+          <br />
+      #end
+        </td>
+        <td>
+      #foreach($ruleDoc in $ruleFamily.otherRules2)
+        <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
+            ${ruleDoc.ruleName}
+          </a>
+          <br />
+      #end
+        </td>
+      </tr>
     #end
-      </td>
-      <td>
-    #foreach($ruleDoc in $ruleFamily.otherRules1)
-      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
-          ${ruleDoc.ruleName}
-        </a>
-        <br />
-    #end
-      </td>
-      <td>
-    #foreach($ruleDoc in $ruleFamily.otherRules2)
-      <a href="${ruleFamily.id}.html#${ruleDoc.ruleName}"#if($ruleDoc.isDeprecated()) class="deprecated"#end>
-          ${ruleDoc.ruleName}
-        </a>
-        <br />
-    #end
-      </td>
-    </tr>
   #end
   </tbody>
 #end
-- 
cgit v1.2.3