diff options
author | David Chen <dzc@google.com> | 2016-01-20 11:06:35 +0000 |
---|---|---|
committer | Han-Wen Nienhuys <hanwen@google.com> | 2016-01-20 11:36:59 +0000 |
commit | c4af8287cd92ba4fe30dddb6f6c3fc881fe470fa (patch) | |
tree | f67a7160cd76ff9f39ba02aeb2c198cd368b8a19 | |
parent | d22b02426bd251213e82c1afb5213174c804c719 (diff) |
Add titles to Bazel documentation pages.
Fixes #790
--
MOS_MIGRATED_REVID=112563137
38 files changed, 119 insertions, 1 deletions
diff --git a/site/blog/index.md b/site/blog/index.md index 4e8755cfdb..5f2d3761ba 100644 --- a/site/blog/index.md +++ b/site/blog/index.md @@ -1,5 +1,6 @@ --- layout: blog +title: Blog --- {% for post in site.categories.blog %} diff --git a/site/contributing.md b/site/contributing.md index b32a4a327d..ea55f4043d 100644 --- a/site/contributing.md +++ b/site/contributing.md @@ -1,5 +1,6 @@ --- layout: community +title: Contributing to Bazel --- # Contributing to Bazel diff --git a/site/docs/bazel-user-manual.html b/site/docs/bazel-user-manual.html index d3db726051..a140540d71 100644 --- a/site/docs/bazel-user-manual.html +++ b/site/docs/bazel-user-manual.html @@ -1,3 +1,7 @@ +--- +layout: documentation +title: User Manual +--- <h1>A User's Guide to Bazel</h1> <h2 id='overview'>Bazel overview</h2> diff --git a/site/docs/build-ref.html b/site/docs/build-ref.html index eed9bf7891..87004ca05c 100644 --- a/site/docs/build-ref.html +++ b/site/docs/build-ref.html @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Concepts +--- <h1>Bazel: Concepts and Terminology</h1> <p> This document provides an overview of concepts and terminology used diff --git a/site/docs/cpp.md b/site/docs/cpp.md index 7a194e0b48..8ae8595a11 100644 --- a/site/docs/cpp.md +++ b/site/docs/cpp.md @@ -1,5 +1,6 @@ --- layout: documentation +title: C++ Basics --- C++ Basics diff --git a/site/docs/external.md b/site/docs/external.md index 29646ed6a2..14480d9aa3 100644 --- a/site/docs/external.md +++ b/site/docs/external.md @@ -1,5 +1,6 @@ --- layout: documentation +title: External Dependencies --- # Working with external dependencies diff --git a/site/docs/getting-started.md b/site/docs/getting-started.md index 510445b7e6..613793c2b5 100644 --- a/site/docs/getting-started.md +++ b/site/docs/getting-started.md @@ -1,5 +1,6 @@ --- layout: documentation +title: Getting Started --- # Getting Started with Bazel diff --git a/site/docs/install.md b/site/docs/install.md index ee77bb98c3..0d2ee3cb59 100644 --- a/site/docs/install.md +++ b/site/docs/install.md @@ -1,5 +1,6 @@ --- layout: documentation +title: Installing Bazel --- # Installing Bazel diff --git a/site/docs/mobile-install.md b/site/docs/mobile-install.md index 2314ee113d..f273871d0d 100644 --- a/site/docs/mobile-install.md +++ b/site/docs/mobile-install.md @@ -1,5 +1,6 @@ --- layout: documentation +title: mobile-install --- # bazel mobile-install diff --git a/site/docs/output_directories.md b/site/docs/output_directories.md index 4ba607350d..f3b40f0409 100644 --- a/site/docs/output_directories.md +++ b/site/docs/output_directories.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Output Directory Layout +--- + # Output Directory Layout ## Requirements diff --git a/site/docs/query.html b/site/docs/query.html index b2438b61b9..8d76b22f65 100644 --- a/site/docs/query.html +++ b/site/docs/query.html @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Query Language +--- <h1>The Bazel Query Reference</h1> <p> diff --git a/site/docs/skyframe.md b/site/docs/skyframe.md index 0c5e2be2fc..de2a0b725e 100644 --- a/site/docs/skyframe.md +++ b/site/docs/skyframe.md @@ -1,5 +1,6 @@ --- layout: documentation +title: Skyframe --- # Skyframe diff --git a/site/docs/skylark/concepts.md b/site/docs/skylark/concepts.md index e8a6ab2b0c..76e1fe98f0 100644 --- a/site/docs/skylark/concepts.md +++ b/site/docs/skylark/concepts.md @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Skylark - Concepts +--- # Concepts ## Loading a Skylark extension diff --git a/site/docs/skylark/cookbook.md b/site/docs/skylark/cookbook.md index c4f718faea..c479a103b7 100644 --- a/site/docs/skylark/cookbook.md +++ b/site/docs/skylark/cookbook.md @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Skylark Cookbook +--- Skylark cookbook ================ @@ -90,7 +94,7 @@ def system_test_suite(name, flavors=["default"], test_files): for flavor in flavors: for test in test_files: ts.append(system_test(name, flavor, test)) - native.test_suite(name = name, tests = ts) + native.test_suite(name = name, tests = ts) ``` In the following BUILD file, note how `(fast, basic_test.py)` is emitted for diff --git a/site/docs/skylark/index.md b/site/docs/skylark/index.md index 71a282accb..49164ff088 100644 --- a/site/docs/skylark/index.md +++ b/site/docs/skylark/index.md @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Custom Rules +--- # Custom rules Skylark is the code name of the extension mechanism for Bazel. It lets you write diff --git a/site/docs/skylark/macros.md b/site/docs/skylark/macros.md index f4f6129385..1ecf59eb4e 100644 --- a/site/docs/skylark/macros.md +++ b/site/docs/skylark/macros.md @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Macros +--- # Macros ## Macro creation diff --git a/site/docs/skylark/rules.md b/site/docs/skylark/rules.md index 8004789c50..12d6f96f4a 100644 --- a/site/docs/skylark/rules.md +++ b/site/docs/skylark/rules.md @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Skylark Rules +--- Rules ===== diff --git a/site/docs/test-encyclopedia.html b/site/docs/test-encyclopedia.html index 7aec9e9cf1..7429066079 100644 --- a/site/docs/test-encyclopedia.html +++ b/site/docs/test-encyclopedia.html @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Test Encyclopedia +--- <h1>Bazel Test Encyclopedia</h1> <p class="lead">An Exhaustive Specification of the Test Execution Environment</p> diff --git a/site/docs/tutorial/android-app.md b/site/docs/tutorial/android-app.md index d58cf39fa9..65bc7da66f 100644 --- a/site/docs/tutorial/android-app.md +++ b/site/docs/tutorial/android-app.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Build an Android App +--- + # Tutorial - Build an Android App The sample Android app in this tutorial is a very simple application that makes diff --git a/site/docs/tutorial/backend-server.md b/site/docs/tutorial/backend-server.md index fc85cd6f62..073ffbc7c7 100644 --- a/site/docs/tutorial/backend-server.md +++ b/site/docs/tutorial/backend-server.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Build the Backend Server +--- + # Tutorial - Build the Backend Server The backend server is a simple web application that runs on Google App Engine diff --git a/site/docs/tutorial/environment.md b/site/docs/tutorial/environment.md index 5cd9972757..219060de7c 100644 --- a/site/docs/tutorial/environment.md +++ b/site/docs/tutorial/environment.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Set Up Your Environment +--- + # Tutorial - Set Up Your Environment The first step in this tutorial is to set up your environment. diff --git a/site/docs/tutorial/index.md b/site/docs/tutorial/index.md index 6d15484d8b..c7e5d24873 100644 --- a/site/docs/tutorial/index.md +++ b/site/docs/tutorial/index.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Introduction +--- + # Tutorial - Introduction You can use Bazel to build a variety of software outputs, including diff --git a/site/docs/tutorial/ios-app.md b/site/docs/tutorial/ios-app.md index 9faf711a05..b4acb20f2a 100644 --- a/site/docs/tutorial/ios-app.md +++ b/site/docs/tutorial/ios-app.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Build an iOS App +--- + # Tutorial - Build an iOS App Like the [Android app](android-app.md) you built in the previous step, the iOS diff --git a/site/docs/tutorial/review.md b/site/docs/tutorial/review.md index ed5f5ff503..62d4501ad4 100644 --- a/site/docs/tutorial/review.md +++ b/site/docs/tutorial/review.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Review +--- + # Tutorial - Review In this tutorial, you used Bazel to build an [Android app](android-app.md), diff --git a/site/docs/tutorial/workspace.md b/site/docs/tutorial/workspace.md index be8883216a..ff3f6da510 100644 --- a/site/docs/tutorial/workspace.md +++ b/site/docs/tutorial/workspace.md @@ -1,3 +1,8 @@ +--- +layout: documentation +title: Tutorial - Set Up a Workspace +--- + # Tutorial - Set Up a Workspace A [workspace](/docs/build-ref.html#workspaces) is a directory that contains the diff --git a/site/docs/windows.md b/site/docs/windows.md index 3761b5c407..038c7e1a8f 100644 --- a/site/docs/windows.md +++ b/site/docs/windows.md @@ -1,5 +1,6 @@ --- layout: documentation +title: Windows --- Building Bazel on Windows diff --git a/site/governance.md b/site/governance.md index c94b110ff7..d9b4ed9f69 100644 --- a/site/governance.md +++ b/site/governance.md @@ -1,5 +1,6 @@ --- layout: community +title: Governance --- # Governance diff --git a/site/index.html b/site/index.html index 30173dfcf2..3e2c9db7a6 100644 --- a/site/index.html +++ b/site/index.html @@ -1,5 +1,6 @@ --- layout: home +title: Home --- <div class="hero"> diff --git a/site/roadmap.md b/site/roadmap.md index 75865a791e..0fa75e6317 100644 --- a/site/roadmap.md +++ b/site/roadmap.md @@ -1,5 +1,6 @@ --- layout: community +title: Roadmap --- # Bazel Feature Roadmap diff --git a/site/support.md b/site/support.md index fe07f0985d..1cad480756 100644 --- a/site/support.md +++ b/site/support.md @@ -1,5 +1,6 @@ --- layout: community +title: Support Policy --- # Support Policy diff --git a/site/users.md b/site/users.md index e9ef68ecf3..1e68300bda 100644 --- a/site/users.md +++ b/site/users.md @@ -1,5 +1,6 @@ --- layout: community +title: Bazel Users --- # Corporate users of Bazel diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm index aa3f96c4f9..63598e9064 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/common-definitions.vm @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Common Definitions +--- #parse("com/google/devtools/build/docgen/templates/be/header.vm") <h1>Common definitions</h1> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm index 7b441c1ff9..49105b2c25 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/functions.vm @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Functions +--- #parse("com/google/devtools/build/docgen/templates/be/header.vm") <h1>Functions</h1> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm index 02c8055d05..684f998b8f 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/make-variables.vm @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Make Variables +--- #parse("com/google/devtools/build/docgen/templates/be/header.vm") <!-- ============================================ 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 38aeeb72c8..33b24fb33f 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 @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Build Encyclopedia +--- #parse("com/google/devtools/build/docgen/templates/be/header.vm") <h1>Bazel BUILD Encyclopedia of Functions</h1> 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 index be0b1965fb..c50fb8a2ba 100644 --- 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 @@ -1,3 +1,7 @@ +--- +layout: documentation +title: Predefined Python Variables +--- #parse("com/google/devtools/build/docgen/templates/be/header.vm") <h2 id="predefined-python-variables">Predefined Python Variables</h2> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/be/rules.vm b/src/main/java/com/google/devtools/build/docgen/templates/be/rules.vm index fc54f25f4b..9e9345cf62 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/be/rules.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/be/rules.vm @@ -1,3 +1,7 @@ +--- +layout: documentation +title: ${ruleFamily.name} Rules +--- #parse("com/google/devtools/build/docgen/templates/be/header.vm") <h1>${ruleFamily.name} Rules</h1> diff --git a/src/main/java/com/google/devtools/build/docgen/templates/skylark-library.vm b/src/main/java/com/google/devtools/build/docgen/templates/skylark-library.vm index 5646e10733..83f65403e6 100644 --- a/src/main/java/com/google/devtools/build/docgen/templates/skylark-library.vm +++ b/src/main/java/com/google/devtools/build/docgen/templates/skylark-library.vm @@ -1,3 +1,7 @@ +--- +layout: documentation +title: ${module.title} +--- <h1 id="modules.${module.name}">${module.title}</h1> ${module.documentation} |