aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar dzc <dzc@google.com>2017-06-14 22:52:27 +0200
committerGravatar Yun Peng <pcloudy@google.com>2017-06-16 09:26:43 +0200
commit51dcd2830647817ef956563a45c33966bd65b096 (patch)
treefa63960378101423c1dfea74ac81d8e84eca3659
parent6628e4321feecc426101da0eb5dcdf3562c5ae1b (diff)
Fix couple of code blocks, doc paths in docgen templates.
* Replace ```shell with ```sh to fix jekyll build errors * Fix paths in docgen templates for new docs site directory structure. * Add jekyll build output directories to gitignore. RELNOTES: None PiperOrigin-RevId: 159020213
-rw-r--r--.gitignore3
-rw-r--r--site/docs/tutorial/cpp.md2
-rw-r--r--site/docs/tutorial/java.md4
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/be/be-nav.vm2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/skylark-category.vm2
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/skylark-nav.vm10
-rw-r--r--src/main/java/com/google/devtools/build/docgen/templates/skylark-overview.vm10
8 files changed, 19 insertions, 16 deletions
diff --git a/.gitignore b/.gitignore
index 62dc648893..9b4e4ea7ee 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,3 +14,6 @@
/bazel-*
# Ignore outputs generated during Bazel bootstrapping.
/output/
+# Ignore jekyll build output.
+/production
+/.sass-cache
diff --git a/site/docs/tutorial/cpp.md b/site/docs/tutorial/cpp.md
index dbf90f5487..e0a5e70b56 100644
--- a/site/docs/tutorial/cpp.md
+++ b/site/docs/tutorial/cpp.md
@@ -152,7 +152,7 @@ through its contents to get an idea for Bazel's output structure.
Now test your freshly built binary:
-```shell
+```sh
bazel-bin/main/hello-world
```
diff --git a/site/docs/tutorial/java.md b/site/docs/tutorial/java.md
index 4a80d472a0..34cb7b5d4c 100644
--- a/site/docs/tutorial/java.md
+++ b/site/docs/tutorial/java.md
@@ -29,7 +29,7 @@ To prepare for the tutorial, first [Install Bazel](/docs/install.md) if
you don't have it installed already. Then, retrieve the sample project from
Bazel's GitHub repository:
-```
+```sh
git clone https://github.com/bazelbuild/examples/
```
@@ -134,7 +134,7 @@ through its contents to get an idea for Bazel's output structure.
Now test your freshly built binary:
-```shell
+```sh
bazel-bin/ProjectRunner
```
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html
index 752e9d0418..f6d1ea656b 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html
+++ b/src/main/java/com/google/devtools/build/docgen/templates/attributes/common/tags.html
@@ -10,7 +10,7 @@
<i>Tags</i> on non-test rules are used to control sandboxed execution of
<code>genrule</code>s and
-<a href="{{ page.version_prefix }}/docs/skylark/index.html">Skylark</a>
+<a href="/versions/{{ site.version }}/skylark/index.html">Skylark</a>
actions, and for parsing by humans and/or external tools.
</p>
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 37c5a73e1b..f68e83d0d9 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
@@ -1,4 +1,4 @@
-#set ($path = "{{ page.version_prefix }}/docs/be")
+#set ($path = "/versions/{{ site.version }}/be")
#set ($bazelbuildGithub = "https://github.com/bazelbuild")
<h3>Build Encyclopedia</h3>
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 604f89abf5..64646d4dd4 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
@@ -10,7 +10,7 @@ ${category.description}
<ul>
#foreach ($module in $modules)
-<li><a href="{{ page.version_prefix }}/docs/skylark/lib/${module.name}.html">${module.title}</a></li>
+<li><a href="/versions/{{ site.version }}/skylark/lib/${module.name}.html">${module.title}</a></li>
#end
</ul>
</div>
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/skylark-nav.vm b/src/main/java/com/google/devtools/build/docgen/templates/skylark-nav.vm
index 51594c22a0..709f95f402 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/skylark-nav.vm
+++ b/src/main/java/com/google/devtools/build/docgen/templates/skylark-nav.vm
@@ -1,5 +1,5 @@
-<li><a href="{{ page.version_prefix }}/docs/skylark/lib/globals.html">Globals</a></li>
-<li><a href="{{ page.version_prefix }}/docs/skylark/lib/skylark-builtin.html">Builtin Types and Modules</a></li>
-<li><a href="{{ page.version_prefix }}/docs/skylark/lib/skylark-configuration-fragment.html">Configuration fragments</a></li>
-<li><a href="{{ page.version_prefix }}/docs/skylark/lib/skylark-provider.html">Providers</a></li>
-<li><a href="{{ page.version_prefix }}/docs/skylark/lib/skylark-overview.html">One-Page Overview</a></li>
+<li><a href="/versions/{{ site.version }}/skylark/lib/globals.html">Globals</a></li>
+<li><a href="/versions/{{ site.version }}/skylark/lib/skylark-builtin.html">Builtin Types and Modules</a></li>
+<li><a href="/versions/{{ site.version }}/skylark/lib/skylark-configuration-fragment.html">Configuration fragments</a></li>
+<li><a href="/versions/{{ site.version }}/skylark/lib/skylark-provider.html">Providers</a></li>
+<li><a href="/versions/{{ site.version }}/skylark/lib/skylark-overview.html">One-Page Overview</a></li>
diff --git a/src/main/java/com/google/devtools/build/docgen/templates/skylark-overview.vm b/src/main/java/com/google/devtools/build/docgen/templates/skylark-overview.vm
index fbce1bb3e8..e1c791477b 100644
--- a/src/main/java/com/google/devtools/build/docgen/templates/skylark-overview.vm
+++ b/src/main/java/com/google/devtools/build/docgen/templates/skylark-overview.vm
@@ -9,7 +9,7 @@ A list of all modules and globals that are available in Skylark:
<h2>
- <a href="{{ page.version_prefix }}/docs/skylark/lib/${global_name}.html">Global Functions & Constants</a>
+ <a href="/versions/{{ site.version }}/skylark/lib/${global_name}.html">Global Functions & Constants</a>
</h2>
@@ -21,7 +21,7 @@ A list of all modules and globals that are available in Skylark:
<li>
- <a href="{{ page.version_prefix }}/docs/skylark/lib/${global_name}.html#${name}">${name}</a>
+ <a href="/versions/{{ site.version }}/skylark/lib/${global_name}.html#${name}">${name}</a>
</li>
@@ -41,7 +41,7 @@ A list of all modules and globals that are available in Skylark:
<li>
- <a href="{{ page.version_prefix }}/docs/skylark/lib/${name}.html">${name}</a>
+ <a href="/versions/{{ site.version }}/skylark/lib/${name}.html">${name}</a>
</li>
@@ -54,7 +54,7 @@ A list of all modules and globals that are available in Skylark:
<h2>
- <a href="{{ page.version_prefix }}/docs/skylark/lib/skylark-${entry.key.templateIdentifier}.html">${entry.key.title}</a>
+ <a href="/versions/{{ site.version }}/skylark/lib/skylark-${entry.key.templateIdentifier}.html">${entry.key.title}</a>
</h2>
@@ -65,7 +65,7 @@ A list of all modules and globals that are available in Skylark:
<li>
- <a href="{{ page.version_prefix }}/docs/skylark/lib/${module.name}.html">${module.title}</a>
+ <a href="/versions/{{ site.version }}/skylark/lib/${module.name}.html">${module.title}</a>
</li>