Remove Renderer-java dependency on default vm templates.
RELNOTES: None.
PiperOrigin-RevId: 261400252
diff --git a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java
index 1a58afc..32e82c7 100644
--- a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java
+++ b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererMain.java
@@ -23,6 +23,7 @@
import com.google.devtools.common.options.OptionsParser;
import com.google.protobuf.InvalidProtocolBufferException;
import java.io.FileInputStream;
+import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
@@ -47,6 +48,17 @@
String inputPath = rendererOptions.inputPath;
String outputPath = rendererOptions.outputFilePath;
+
+ if (rendererOptions.headerTemplateFilePath.isEmpty()
+ || rendererOptions.ruleTemplateFilePath.isEmpty()
+ || rendererOptions.providerTemplateFilePath.isEmpty()
+ || rendererOptions.funcTemplateFilePath.isEmpty()
+ || rendererOptions.aspectTemplateFilePath.isEmpty()) {
+ throw new FileNotFoundException(
+ "Input templates --header_template --func_template --provider_template --rule_template"
+ + " --aspect_template must be specified.");
+ }
+
String headerTemplatePath = rendererOptions.headerTemplateFilePath;
String ruleTemplatePath = rendererOptions.ruleTemplateFilePath;
String providerTemplatePath = rendererOptions.providerTemplateFilePath;
diff --git a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java
index 730cb06..841278d 100644
--- a/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java
+++ b/src/main/java/com/google/devtools/build/skydoc/renderer/RendererOptions.java
@@ -40,7 +40,7 @@
@Option(
name = "header_template",
- defaultValue = "com/google/devtools/build/skydoc/rendering/templates/header.vm",
+ defaultValue = "",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = OptionEffectTag.UNKNOWN,
help =
@@ -50,7 +50,7 @@
@Option(
name = "rule_template",
- defaultValue = "com/google/devtools/build/skydoc/rendering/templates/rule.vm",
+ defaultValue = "",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = OptionEffectTag.UNKNOWN,
help =
@@ -60,7 +60,7 @@
@Option(
name = "provider_template",
- defaultValue = "com/google/devtools/build/skydoc/rendering/templates/provider.vm",
+ defaultValue = "",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = OptionEffectTag.UNKNOWN,
help =
@@ -70,7 +70,7 @@
@Option(
name = "func_template",
- defaultValue = "com/google/devtools/build/skydoc/rendering/templates/func.vm",
+ defaultValue = "",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = OptionEffectTag.UNKNOWN,
help =
@@ -80,7 +80,7 @@
@Option(
name = "aspect_template",
- defaultValue = "com/google/devtools/build/skydoc/rendering/templates/aspect.vm",
+ defaultValue = "",
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
effectTags = OptionEffectTag.UNKNOWN,
help =
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/aspect.vm b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/aspect.vm
deleted file mode 100644
index 35e5441..0000000
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/aspect.vm
+++ /dev/null
@@ -1,56 +0,0 @@
-<a name="#${aspectName}"></a>
-
-#[[##]]# ${aspectName}
-
-<pre>
-${util.aspectSummary($aspectName, $aspectInfo)}
-</pre>
-
-$aspectInfo.getDocString()
-
-#[[###]]# Aspect Attributes
-
-#if (!$aspectInfo.getAspectAttributeList().isEmpty())
-<table class="params-table">
- <colgroup>
- <col class="col-param" />
- <col class="col-description" />
- </colgroup>
- <tbody>
-#foreach ($aspectAttribute in $aspectInfo.getAspectAttributeList())
- <tr id="${aspectName}-${aspectAttribute}">
- <td><code>${aspectAttribute}</code></td>
- <td>
- String; required.
-#end
- </td>
- </tr>
-#end
- </tbody>
-</table>
-
-#[[###]]# Attributes
-
-#if (!$aspectInfo.getAttributeList().isEmpty())
-<table class="params-table">
- <colgroup>
- <col class="col-param" />
- <col class="col-description" />
- </colgroup>
- <tbody>
-#foreach ($attribute in $aspectInfo.getAttributeList())
- <tr id="${aspectName}-${attribute.name}">
- <td><code>${attribute.name}</code></td>
- <td>
- ${util.attributeTypeString($attribute)}; ${util.mandatoryString($attribute)}
-#if (!$attribute.docString.isEmpty())
- <p>
- ${attribute.docString.trim()}
- </p>
-#end
- </td>
- </tr>
-#end
- </tbody>
-</table>
-#end
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/func.vm b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/func.vm
deleted file mode 100644
index 0f70f7a..0000000
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/func.vm
+++ /dev/null
@@ -1,36 +0,0 @@
-<a name="#${funcInfo.functionName}"></a>
-
-#[[##]]# ${funcInfo.functionName}
-
-<pre>
-${util.funcSummary($funcInfo)}
-</pre>
-
-${util.htmlEscape($funcInfo.docString)}
-
-#if (!$funcInfo.getParameterList().isEmpty())
-#[[###]]# Parameters
-
-<table class="params-table">
- <colgroup>
- <col class="col-param" />
- <col class="col-description" />
- </colgroup>
- <tbody>
-#foreach ($param in $funcInfo.getParameterList())
- <tr id="${funcInfo.functionName}-${param.name}">
- <td><code>${param.name}</code></td>
- <td>
- ${util.mandatoryString($param)}.#if(!$param.getDefaultValue().isEmpty()) default is <code>$param.getDefaultValue()</code>#end
-
-#if (!$param.docString.isEmpty())
- <p>
- ${param.docString.trim()}
- </p>
-#end
- </td>
- </tr>
-#end
- </tbody>
-</table>
-#end
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/header.vm b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/header.vm
deleted file mode 100644
index 187680d..0000000
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/header.vm
+++ /dev/null
@@ -1 +0,0 @@
-<!-- Generated with Stardoc: http://skydoc.bazel.build -->
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/provider.vm b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/provider.vm
deleted file mode 100644
index 1d2f032..0000000
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/provider.vm
+++ /dev/null
@@ -1,30 +0,0 @@
-<a name="#${providerName}"></a>
-
-#[[##]]# ${providerName}
-
-<pre>
-${util.providerSummary($providerName, $providerInfo)}
-</pre>
-
-${util.htmlEscape($providerInfo.docString)}
-
-#if (!$providerInfo.fieldInfoList.isEmpty())
-#[[###]]# Fields
-
-<table class="params-table">
- <colgroup>
- <col class="col-param" />
- <col class="col-description" />
- </colgroup>
- <tbody>
-#foreach ($field in $providerInfo.fieldInfoList)
- <tr id="${providerName}-${field.name}">
- <td><code>${field.name}</code></td>
- <td>
- <p>${field.docString}</p>
- </td>
- </tr>
-#end
- </tbody>
-</table>
-#end
diff --git a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/rule.vm b/src/main/java/com/google/devtools/build/skydoc/rendering/templates/rule.vm
deleted file mode 100644
index 06ff16f..0000000
--- a/src/main/java/com/google/devtools/build/skydoc/rendering/templates/rule.vm
+++ /dev/null
@@ -1,35 +0,0 @@
-<a name="#${ruleName}"></a>
-
-#[[##]]# ${ruleName}
-
-<pre>
-${util.ruleSummary($ruleName, $ruleInfo)}
-</pre>
-
-${util.htmlEscape($ruleInfo.docString)}
-
-#[[###]]# Attributes
-
-#if (!$ruleInfo.getAttributeList().isEmpty())
-<table class="params-table">
- <colgroup>
- <col class="col-param" />
- <col class="col-description" />
- </colgroup>
- <tbody>
-#foreach ($attribute in $ruleInfo.getAttributeList())
- <tr id="${ruleName}-${attribute.name}">
- <td><code>${attribute.name}</code></td>
- <td>
- ${util.attributeTypeString($attribute)}; ${util.mandatoryString($attribute)}
-#if (!$attribute.docString.isEmpty())
- <p>
- ${attribute.docString.trim()}
- </p>
-#end
- </td>
- </tr>
-#end
- </tbody>
-</table>
-#end
diff --git a/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl b/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl
index 0173e1d..5665ac5 100644
--- a/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl
+++ b/src/test/java/com/google/devtools/build/skydoc/skydoc_test.bzl
@@ -43,7 +43,6 @@
in this test.
golden_file: The label string of the golden file containing the documentation when skydoc
is run on the input file.
- skydoc: The label string of the skydoc binary.
deps: A list of label strings of skylark file dependencies of the input_file.
whitelisted_symbols: A list of strings representing top-level symbols in the input file
to generate documentation for. If empty, documentation for all top-level symbols
