aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/main
diff options
context:
space:
mode:
authorGravatar laurentlb <laurentlb@google.com>2017-07-17 19:41:51 +0200
committerGravatar Damien Martin-Guillerez <dmarting@google.com>2017-07-18 09:48:59 +0200
commit77d141fe2e0b4c1b5d59954dfe6d086c542fea82 (patch)
tree07b0538e91e6e06aa5d030ba00a1d169901939eb /src/main
parent176d894dda80db4872d5f1e5ab8a544f554089a9 (diff)
Delete the "Predefined Python variables" page.
The page was incomplete and almost empty, and also redundant with https://docs.bazel.build/versions/master/skylark/lib/globals.html#PACKAGE_NAME RELNOTES: None. PiperOrigin-RevId: 162234689
Diffstat (limited to 'src/main')
-rw-r--r--src/main/java/com/google/devtools/build/docgen/MultiPageBuildEncyclopediaProcessor.java1
-rw-r--r--src/main/java/com/google/devtools/build/docgen/RuleLinkExpander.java3
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be/be-nav.vm1
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be/overview.vm2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be/predefined-python-variables.vm31
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be/single-page.vm4
6 files changed, 1 insertions, 41 deletions
diff --git a/src/main/java/com/google/devtools/build/docgen/MultiPageBuildEncyclopediaProcessor.java b/src/main/java/com/google/devtools/build/docgen/MultiPageBuildEncyclopediaProcessor.java
index 8ba87211a0..64077c91da 100644
--- a/src/main/java/com/google/devtools/build/docgen/MultiPageBuildEncyclopediaProcessor.java
+++ b/src/main/java/com/google/devtools/build/docgen/MultiPageBuildEncyclopediaProcessor.java
@@ -47,7 +47,6 @@ public class MultiPageBuildEncyclopediaProcessor extends BuildEncyclopediaProces
Sets.difference(ruleClassProvider.getRuleClassMap().keySet(), ruleDocEntries.keySet()));
writeStaticDoc(outputDir, expander, "make-variables");
- writeStaticDoc(outputDir, expander, "predefined-python-variables");
writeStaticDoc(outputDir, expander, "functions");
writeCommonDefinitionsPage(outputDir, expander);
diff --git a/src/main/java/com/google/devtools/build/docgen/RuleLinkExpander.java b/src/main/java/com/google/devtools/build/docgen/RuleLinkExpander.java
index a4ea1ce76a..7ff74ac3c0 100644
--- a/src/main/java/com/google/devtools/build/docgen/RuleLinkExpander.java
+++ b/src/main/java/com/google/devtools/build/docgen/RuleLinkExpander.java
@@ -33,8 +33,7 @@ public class RuleLinkExpander {
private static final String FUNCTIONS_PAGE = "functions";
private static final ImmutableSet<String> STATIC_PAGES =
- ImmutableSet.<String>of(
- "common-definitions", "make-variables", "predefined-python-variables");
+ ImmutableSet.<String>of("common-definitions", "make-variables");
private static final ImmutableMap<String, String> FUNCTIONS =
ImmutableMap.<String, String>builder()
.put("load", FUNCTIONS_PAGE)
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 f68e83d0d9..a9b8f6668c 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
@@ -15,7 +15,6 @@
<ul class="collapse sidebar-nav sidebar-submenu" id="be-menu">
<li><a href="${path}/common-definitions.html">Common Definitions</a></li>
<li><a href="${path}/make-variables.html">"Make" variables</a></li>
- <li><a href="${path}/predefined-python-variables.html">Predefined Python Variables</a></li>
</ul>
</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 b1c299fb80..d7b02e69ba 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
@@ -30,11 +30,9 @@ title: Build Encyclopedia
<a href="$expander.expandRef("make-variables")">"Make" variables</a>
<ul class="be-toc">
<li><a href="$expander.expandRef("make-variables#make-var-substitution")">"Make" variable substitution</a></li>
- <li><a href="$expander.expandRef("make-variables#predefined_variables")">Predefined variables</a></li>
</ul>
</li>
- <li><a href="$expander.expandRef("predefined-python-variables")">Predefined Python Variables</a></li>
</ul>
<h3>Functions</h3>
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/predefined-python-variables.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/predefined-python-variables.vm
deleted file mode 100644
index 1477a1afa9..0000000000
--- a/src/main/java/com/google/devtools/build/docgen/templates/be/predefined-python-variables.vm
+++ /dev/null
@@ -1,31 +0,0 @@
-#if (!$singlePage)
----
-layout: documentation
-title: Predefined Python Variables
----
-#end
-#if (!$singlePage)
-#parse("com/google/devtools/build/docgen/templates/be/header.vm")
-#end
-
-<h2 id="predefined-python-variables">Predefined Python Variables</h2>
-
-#if (!$singlePage)
-<div class="toc">
- <h1>Contents</h1>
- <ul>
- <li><a href="#packagename">packagename</a></li>
- </ul>
-</div>
-#end
-<h3 id="packagename">PACKAGE_NAME</h3>
-<p>
- This is a string variable with the name of the package being evaluated. In
- particular, when <code>PACKAGE_NAME</code> appears in a <code>.bzl</code>
- file, its value will be the package that <i>uses</i> the .bzl file, not the
- package that contains it.
-</p>
-
-#if (!$singlePage)
-#parse("com/google/devtools/build/docgen/templates/be/footer.vm")
-#end
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/single-page.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/single-page.vm
index 23cb684b00..db1a403c63 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/be/single-page.vm
+++ b/src/main/java/com/google/devtools/build/docgen/templates/be/single-page.vm
@@ -12,10 +12,6 @@
<hr>
-#parse("com/google/devtools/build/docgen/templates/be/predefined-python-variables.vm")
-
-<hr>
-
#parse("com/google/devtools/build/docgen/templates/be/functions.vm")
#foreach ($ruleFamily in $ruleFamilies)