aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/_layouts/documentation.html
blob: 124e2be700b89346a07e45271a5558bc68c7e78d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
---
nav: docs
---

<!DOCTYPE html>
<html lang="en" itemscope itemtype="https://schema.org/WebPage">
  {% include head.html %}
  <body>
    {% include header.html %}

    <div class="page-title-bar">
      <div class="container">
        <h1>Documentation</h1>
      </div>
    </div>

    <div class="container vpad">
      <div class="row">
        <div class="col-lg-3">
          <a class="btn btn-default btn-lg btn-block sidebar-toggle"
              data-toggle="collapse" href="#sidebar-nav" aria-expanded="false"
              aria-controls="sidebar-nav">
            <i class="glyphicon glyphicon-menu-hamburger"></i> Navigation
          </a>
          <nav class="sidebar collapse" id="sidebar-nav">
           <h3>Home</h3>
            <ul class="sidebar-nav">
              <li><a href="/versions/{{ site.version }}/bazel-overview.html">Bazel Overview</a></li>
              <li><a href="/versions/{{ site.version }}/experimental.html">Experimental Features</a></li>
            </ul>

            <h3>Install Bazel</h3>
           <ul class="sidebar-nav">
              <li><a href="/versions/{{ site.version }}/install.html">Installation Overview</a></li>
              <li><a href="/versions/{{ site.version }}/install-ubuntu.html">Install on Ubuntu</a></li>
              <li><a href="/versions/{{ site.version }}/install-redhat.html">Install on Fedora/CentOS</a></li>
              <li><a href="/versions/{{ site.version }}/install-os-x.html">Install on macOS</a></li>
              <li><a href="/versions/{{ site.version }}/install-windows.html">Install on Windows</a></li>
              <li><a href="/versions/{{ site.version }}/install-compile-source.html">Compile from Source</a></li>
              <li><a href="/versions/{{ site.version }}/ide.html">Integrate with IDEs</a></li>
            </ul>

          <h3>Tutorials</h3>
           <ul class="sidebar-nav">
              <li><a href="/versions/{{ site.version }}/tutorial/java.html">Build a Java Project</a></li>
              <li><a href="/versions/{{ site.version }}/tutorial/cpp.html">Build a C++ Project</a></li>
              <li><a href="/versions/{{ site.version }}/tutorial/android-app.html">Build an Android App</a></li>
              <li><a href="/versions/{{ site.version }}/tutorial/ios-app.html">Build an iOS App</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/tutorial-sharing-variables.html">Skylark: Share Variables</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/tutorial-creating-a-macro.html">Skylark: Create Macros</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/cookbook.html">Skylark: Example Extensions</a></li>
            </ul>

           <h3>Use Bazel</h3>
            <ul class="sidebar-nav">
              <li><a href="/versions/{{ site.version }}/getting-started.html">Get Started</a></li>
              <li><a href="/versions/{{ site.version }}/user-manual.html">User Manual</a></li>

              <li>
                <a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#cpp-menu" aria-expanded="false"
                    aria-controls="cpp-menu">
                  Bazel and C++<span class="caret"></span>
                </a>
                <ul class="collapse sidebar-nav sidebar-submenu" id="cpp-menu">
                  <li><a href="/versions/{{ site.version }}/bazel-and-cpp.html">C++ Resources</a></li>
                  <li><a href="/versions/{{ site.version }}/cpp-use-cases.html">C++ Use Cases</a></li>
                </ul>
              </li>

              <li>
                <a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#java-menu" aria-expanded="false"
                    aria-controls="java-menu">
                  Bazel and Java<span class="caret"></span>
                </a>
                <ul class="collapse sidebar-nav sidebar-submenu" id="java-menu">
                  <li><a href="/versions/{{ site.version }}/bazel-and-java.html">Java Resources</a></li>
                  <li><a href="/versions/{{ site.version }}/migrate-maven.html">Migrate from Maven</a></li>
                  <li><a href="/versions/{{ site.version }}/generate-workspace.html">Convert Maven Dependencies</a></li>
                </ul>
              </li>

              <li>
                <a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#android-menu" aria-expanded="false"
                    aria-controls="android-menu">
                  Bazel and Android<span class="caret"></span>
                </a>
                <ul class="collapse sidebar-nav sidebar-submenu" id="android-menu">
                  <li><a href="/versions/{{ site.version }}/bazel-and-android.html">Android Resources</a></li>
                  <li><a href="/versions/{{ site.version }}/mobile-install.html">Use mobile-install</a></li>
                </ul>
              </li>

               <li>
                <a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#apple-menu" aria-expanded="false"
                    aria-controls="apple-menu">
                  Bazel and Apple<span class="caret"></span>
                </a>
                <ul class="collapse sidebar-nav sidebar-submenu" id="apple-menu">
                  <li><a href="/versions/{{ site.version }}/bazel-and-apple.html">Apple Resources</a></li>
                  <li><a href="/versions/{{ site.version }}/migrate-xcode.html">Migrate from Xcode</a></li>
                  <li><a href="/versions/{{ site.version }}/migrate-cocoapods.html">Convert CocoaPods</a></li>
                </ul>
              </li>
              <li><a href="/versions/{{ site.version }}/windows.html">Use Bazel on Windows</a></li>
              <li><a href="/versions/{{ site.version }}/external.html">Add External Dependencies</a></li>
              <li><a href="/versions/{{ site.version }}/query-how-to.html">Query Builds</a></li>
              <li><a href="/versions/{{ site.version }}/test-encyclopedia.html">Write Tests</a></li>
              <li><a href="/versions/{{ site.version }}/best-practices.html">Best Practices</a></li>
             </ul>

          <h3>Reference</h3>
           <ul class="sidebar-nav">
             <li><a href="/versions/{{ site.version }}/build-ref.html">Bazel Concepts</a></li>

             <li><a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#be-menu" aria-expanded="false"
                    aria-controls="be-menu">
                  Build Encyclopedia<span class="caret"></span>
                </a>
             <ul class="collapse sidebar-nav sidebar-submenu" id="be-menu">
                  <li><a href="/versions/{{ site.version }}/be/overview.html">Build Overview</a></li>
                  <li><a href="/versions/{{ site.version }}/be/common-definitions.html">Build Concepts</a></li>
                  <li><a href="/versions/{{ site.version }}/be/make-variables.html">Make Variables</a></li>
                  <li><a href="/versions/{{ site.version }}/be/functions.html">Functions</a></li>

                  <li><a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#be-rules-menu" aria-expanded="false"
                    aria-controls="be-rules-menu">
                  Rules<span class="caret"></span>
                      </a>
                    <ul class="collapse sidebar-nav sidebar-submenu" id="be-rules-menu">
                       <li><a href="/versions/{{ site.version }}/be/general.html">General</a></li>
                       <li><a href="/versions/{{ site.version }}/be/workspace.html">Workspace</a></li>
                       <li><a href="/versions/{{ site.version }}/be/platform.html">Platform</a></li>
                       <li><a href="/versions/{{ site.version }}/be/pkg.html">Packaging</a></li>
                       <li><a href="/versions/{{ site.version }}/be/extra-actions.html">Extra Actions</a></li>
                       <li><a href="/versions/{{ site.version }}/be/android.html">Android</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_appengine">AppEngine</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_apple">Apple</a></li>
                       <li><a href="/versions/{{ site.version }}/be/c-cpp.html">C and C++</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_dotnet">C#</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_d">D</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_docker">Docker</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_go">Go</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_groovy">Groovy</a></li>
                       <li><a href="/versions/{{ site.version }}/be/java.html">Java</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_closure">JavaScript (Closure)</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_jsonnet">Jsonnet</a></li>
                       <li><a href="/versions/{{ site.version }}/be/objective-c.html">Objective C</a></li>
                       <li><a href="/versions/{{ site.version }}/be/protocol-buffer.html">Protocol Buffers</a></li>
                       <li><a href="/versions/{{ site.version }}/be/python.html">Python</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_rust">Rust</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_sass">Sass</a></li>
                       <li><a href="https://github.com/bazelbuild/rules_scala">Scala</a></li>
                       <li><a href="/versions/{{ site.version }}/be/shell.html">Shell</a></li>
                    </ul></li>
               </ul></li>

             <li><a href="/versions/{{ site.version }}/skylark/build-style.html">BUILD File Reference</a></li>
             <li><a href="/versions/{{ site.version }}/command-line-reference.html">Command Line Reference</a></li>
             <li><a href="/versions/{{ site.version }}/build-event-protocol.html">Build Event Protocol</a></li>
             <li><a href="/versions/{{ site.version }}/query.html">Bazel Query Language</a></li>
             <li><a href="/versions/{{ site.version }}/output_directories.html">Output Directory Layout</a></li>
             <li><a href="/versions/{{ site.version }}/platforms.html">Platforms</a></li>
             <li><a href="/versions/{{ site.version }}/toolchains.html">Toolchains</a></li>
           </ul>

            <h3>Extend Bazel</h3>
           <ul class="sidebar-nav">
              <li><a href="/versions/{{ site.version }}/skylark/concepts.html">Overview</a></li>

              <li>
                <a class="sidebar-nav-heading" data-toggle="collapse"
                    href="#skylark-concepts" aria-expanded="false"
                    aria-controls="skylark-concepts">
                  Skylark Concepts<span class="caret"></span>
                </a>
                <ul class="collapse sidebar-nav sidebar-submenu" id="skylark-concepts">
                  <li><a href="/versions/{{ site.version }}/skylark/aspects.html">Aspects</a></li>
                  <li><a href="/versions/{{ site.version }}/skylark/depsets.html">Depsets</a></li>
                  <li><a href="/versions/{{ site.version }}/skylark/macros.html">Macros</a></li>
                  <li><a href="/versions/{{ site.version }}/skylark/rules.html">Rules</a></li>
                  <li><a href="/versions/{{ site.version }}/skylark/repository_rules.html">Repository Rules</a></li>
                </ul>
              </li>
              <li><a href="/versions/{{ site.version }}/rule-challenges.html">Write Rules</a></li>
              <li><a href="https://skydoc.bazel.build" target="_blank">Document Rules</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/deploying.html">Deploy Rules</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/performance.html">Optimize Performance</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/backward-compatibility.html">Backward Compatibility</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/skylint.html">Skylark Linter</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/lib/skylark-overview.html">Modules and Globals</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/bzl-style.html">BZL File Reference</a></li>
              <li><a href="/versions/{{ site.version }}/skylark/language.html">Skylark Language Reference</a></li>
            </ul>
          </nav>
        </div>

        <div class="col-lg-9">
          <a id="gh-edit" class="gh-edit default-hidden"><i class="fa fa-pencil" aria-hidden="true"></i> Edit</a>
          <script>
            var versionDocsURLRegex = /\/versions\/[\w\.]+\/(.*)/;
            var ghDocsBazeURL = 'https://github.com/bazelbuild/bazel/tree/master/site/docs/';
            var editButton = document.getElementById('gh-edit');
            // if there is an edit button and we are not in the Build Encyclopedia
            if (editButton
                && window.location.pathname.match(versionDocsURLRegex)
                && window.location.pathname.lastIndexOf('/be/') == -1
                && window.location.pathname.lastIndexOf('/skylark/lib/') == -1) {
              var docFile = window.location.pathname.match(versionDocsURLRegex)[1];
              // some pages are not using markdown :(
              if (docFile !== 'bazel-user-manual.html'
                  && docFile !== 'build-ref.html'
                  && docFile !== 'query.html'
                  && docFile !== 'test-encyclopedia.html') {
                docFile = docFile.replace('html', 'md');
              }
              editButton.href = ghDocsBazeURL + docFile;
              editButton.style.visibility = 'visible';
            }
          </script>

          {{ content }}
        </div>
      </div>
    </div>

    <!-- Satisfaction Survey -->
    <script async="" defer="" src="//survey.g.doubleclick.net/async_survey?site=oohdpic4fyfp3jcnym6aqkdf3e"></script>

    {% include footer.html %}
  </body>
</html>