From 51dcd2830647817ef956563a45c33966bd65b096 Mon Sep 17 00:00:00 2001 From: dzc Date: Wed, 14 Jun 2017 22:52:27 +0200 Subject: [PATCH] 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 --- .gitignore | 3 +++ site/docs/tutorial/cpp.md | 2 +- site/docs/tutorial/java.md | 4 ++-- .../build/docgen/templates/attributes/common/tags.html | 2 +- .../devtools/build/docgen/templates/be/be-nav.vm | 2 +- .../build/docgen/templates/skylark-category.vm | 2 +- .../devtools/build/docgen/templates/skylark-nav.vm | 10 +++++----- .../build/docgen/templates/skylark-overview.vm | 10 +++++----- 8 files changed, 19 insertions(+), 16 deletions(-) diff --git a/.gitignore b/.gitignore index 62dc6488938fd9..9b4e4ea7ee73c2 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 dbf90f5487a72a..e0a5e70b56d383 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 4a80d472a0a59f..34cb7b5d4c9b47 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 752e9d0418c7d3..f6d1ea656b0efb 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 @@ Tags on non-test rules are used to control sandboxed execution of genrules and -Skylark +Skylark actions, and for parsing by humans and/or external tools.

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 37c5a73e1b12d7..f68e83d0d94f6e 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")

Build Encyclopedia

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 604f89abf51a09..64646d4dd46d5a 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} 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 51594c22a0391d..709f95f40217c7 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 @@ -
  • Globals
    • -
  • Builtin Types and Modules
    • -
  • Configuration fragments
    • -
  • Providers
    • -
  • One-Page Overview
    • +
  • Globals
    • +
  • Builtin Types and Modules
    • +
  • Configuration fragments
    • +
  • Providers
    • +
  • One-Page Overview
    • 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 fbce1bb3e857af..e1c791477b943b 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:

    - Global Functions & Constants + Global Functions & Constants

    @@ -21,7 +21,7 @@ A list of all modules and globals that are available in Skylark:
  • - ${name} + ${name}
    • @@ -41,7 +41,7 @@ A list of all modules and globals that are available in Skylark:
  • - ${name} + ${name}
    • @@ -54,7 +54,7 @@ A list of all modules and globals that are available in Skylark:

    - ${entry.key.title} + ${entry.key.title}

    @@ -65,7 +65,7 @@ A list of all modules and globals that are available in Skylark:
  • - ${module.title} + ${module.title}