Skip to content

Commit

Permalink
Fix couple of code blocks, doc paths in docgen templates.
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
davidzchen authored and meteorcloudy committed Jun 16, 2017
1 parent 6628e43 commit 51dcd28
Show file tree
Hide file tree
Showing 8 changed files with 19 additions and 16 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,6 @@
/bazel-*
# Ignore outputs generated during Bazel bootstrapping.
/output/
# Ignore jekyll build output.
/production
/.sass-cache
2 changes: 1 addition & 1 deletion site/docs/tutorial/cpp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down
4 changes: 2 additions & 2 deletions site/docs/tutorial/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/
```

Expand Down Expand Up @@ -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
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
Original file line number Diff line number Diff line change
@@ -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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Original file line number Diff line number Diff line change
@@ -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>
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand All @@ -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>
Expand Down

0 comments on commit 51dcd28

Please sign in to comment.