Merge pull request #33 from google/dgreiman/skydoc
Fix various documentation issues
diff --git a/README.md b/README.md
index e5448e0..d253eb0 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,8 @@
git_repository(
name = "subpar",
remote = "https://github.com/google/subpar",
- commit = "HEAD",
+ tag = "1.0",
+ sha256 = "Fill in sha256 here",
)
```
@@ -26,9 +27,15 @@
## Usage
-`par_binary()` is a drop-in replacement for `py_binary()` that also builds a
-self-contained, single-file executable for the application, with a `.par` file
-extension.
+`par_binary()` is a drop-in replacement for `py_binary()` in your BUILD files
+that also builds a self-contained, single-file executable for the application,
+with a `.par` file extension.
+
+To build the `.par` file associated with a `par_binary(name=myname)` rule, do
+
+``` shell
+bazel build //my/package:myname.par
+```
The .par file is created alongside the python stub and .runfiles
directories that py_binary() creates, but is independent of them.
@@ -44,7 +51,11 @@
## Example
+Given a `BUILD` file with the following:
+
```python
+load("@subpar//:subpar.bzl", "par_binary")
+
par_binary(
name = 'foo',
srcs = ['foo.py', 'bar.py'],
@@ -53,6 +64,12 @@
)
```
+Run the following build command:
+
+``` shell
+bazel build //package:foo.par
+```
+
This results in the following files being created by bazel build:
```
diff --git a/docs/BUILD b/docs/BUILD
index b1abd6a..357be9a 100644
--- a/docs/BUILD
+++ b/docs/BUILD
@@ -12,13 +12,17 @@
)
skylark_doc(
- name = "docs-html",
+ name = "docs-md",
format = "markdown",
+ overview = True,
+ site_root = ".",
deps = ["subpar-rules"],
)
skylark_doc(
- name = "docs-md",
+ name = "docs-html",
format = "html",
+ overview = True,
+ site_root = ".",
deps = ["subpar-rules"],
)
diff --git a/docs/css/main.css b/docs/css/main.css
deleted file mode 100755
index f46dd08..0000000
--- a/docs/css/main.css
+++ /dev/null
@@ -1,3 +0,0 @@
-body{background-color:#fafafa}pre,code{font-family:'Liberation Mono', Consolas, Monaco, 'Andale Mono', monospace}pre{background-color:#eee;padding:20px;overflow-x:auto;word-wrap:normal}pre code{overflow-wrap:normal;white-space:pre}code{display:inline-block;font-size:90%;white-space:pre-wrap}.mdl-layout__drawer{background-color:#fff}.mdl-layout__drawer .mdl-layout-title{border-bottom:1px solid #e0e0e0;padding-left:24px}.drawer-nav ul{list-style:none;padding-left:0}.drawer-nav ul li{display:block;padding:0}.drawer-nav ul li ul li a{padding-left:44px;font-weight:400}.drawer-nav ul li a{display:block;flex-shrink:0;padding:15px 0 15px 22px;margin:0;font-weight:600;color:#757575;line-height:1em;text-decoration:none;cursor:pointer}.drawer-nav ul li a:active,.drawer-nav ul li a:hover{background-color:#f0f0f0}.drawer-nav ul li.active a{color:#4caf50;font-weight:500}h1.page-title{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}p.lead{font-size:20px;line-height:32px}table{border-collapse:collapse;border-spacing:0;background-color:#fff;table-layout:auto}table thead th{background-color:#fafafa;border:1px solid #eee;color:#757575;padding:12px 12px 12px 24px;vertical-align:top}table tbody td{border:1px solid #eee;padding:12px 12px 12px 24px;vertical-align:top}table.params-table{width:100%}table.params-table col.col-param{width:25%}table.params-table col.col-description{width:75%}hr{margin-top:80px;margin-bottom:80px}nav.toc{border-left:5px solid #4caf50;padding-left:20px;margin-bottom:48px}nav.toc h1,nav.toc h2{font-size:15px;line-height:16px;padding-bottom:12px;margin-bottom:0;font-weight:400;color:#757575}nav.toc ul{list-style:none;margin-top:0;padding-left:0}nav.toc ul li{font-size:20px;line-height:40px}nav.toc ul li a{color:#4caf50}.page-content{margin-left:auto;margin-right:auto;padding-top:60px;padding-bottom:60px;width:760px}.page-content a{text-decoration:none}.page-content h1{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}.page-content h2{font-size:24px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}.page-content h3{font-size:20px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}@media (max-width: 768px){.page-content{width:360px}}@media (min-width: 768px){.page-content{width:760px}}@media (min-width: 1476px){.page-content{width:1160px}}.mdl-mini-footer{padding-left:40px}
-
-/*# sourceMappingURL=main.css.map */
\ No newline at end of file
diff --git a/docs/debug.html b/docs/debug.html
index a285791..d59ce49 100644
--- a/docs/debug.html
+++ b/docs/debug.html
@@ -1,4 +1,5 @@
+
<!--
Documentation generated by Skydoc
-->
@@ -15,7 +16,7 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">
<script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>
- <link rel="stylesheet" href="css/main.css">
+ <link rel="stylesheet" href="./main.css">
</head>
<body>
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer
@@ -30,17 +31,21 @@
<nav class="drawer-nav">
<ul class="drawer-nav">
+<li><a href="./index.html">Overview</a></li>
<li>
- <a href="debug.html">debug</a>
+ <a href="./debug.html">debug Rules</a>
<ul>
- <li><a href="debug.html#dump">dump</a></li>
</ul>
</li>
+<li><a href="./index.html">Overview</a></li>
<li>
- <a href="subpar.html">subpar</a>
+ <a href="./subpar.html">Build self-contained python executables.</a>
<ul>
- <li><a href="subpar.html#par_binary">par_binary</a></li>
- <li><a href="subpar.html#parfile">parfile</a></li>
+ <li>
+ <a href="./subpar.html#parfile">
+ parfile
+ </a>
+ </li>
</ul>
</li>
@@ -53,7 +58,7 @@
<h1>debug Rules</h1>
<nav class="toc">
- <h2>Rules</h2>
+ <h2>Macros</h2>
<ul>
<li><a href="#dump">dump</a></li>
</ul>
@@ -105,6 +110,8 @@
</tr>
</tbody>
</table>
+
+
</div>
<footer class="mdl-mini-footer">
diff --git a/docs/debug.md b/docs/debug.md
index ee3cf80..10da3dc 100644
--- a/docs/debug.md
+++ b/docs/debug.md
@@ -6,7 +6,7 @@
<nav class="toc">
- <h2>Rules</h2>
+ <h2>Macros</h2>
<ul>
<li><a href="#dump">dump</a></li>
</ul>
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..cec389b
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,149 @@
+
+
+<!--
+Documentation generated by Skydoc
+-->
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width initial-scale=1" />
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
+
+ <title>Overview</title>
+
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,500,600,700" type="text/css">
+ <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
+ <link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">
+ <script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>
+ <link rel="stylesheet" href="./main.css">
+ </head>
+ <body>
+ <div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer
+ mdl-layout--fixed-header">
+ <header class="mdl-layout__header">
+ <div class="mdl-layout__header-row">
+ <span class="mdl-layout-title">Overview</span>
+ </div>
+ </header>
+ <div class="mdl-layout__drawer">
+ <span class="mdl-layout-title">Bazel</span>
+ <nav class="drawer-nav">
+ <ul class="drawer-nav">
+
+<li><a href="./index.html">Overview</a></li>
+<li>
+ <a href="./debug.html">debug Rules</a>
+ <ul>
+ </ul>
+</li>
+<li><a href="./index.html">Overview</a></li>
+<li>
+ <a href="./subpar.html">Build self-contained python executables.</a>
+ <ul>
+ <li>
+ <a href="./subpar.html#parfile">
+ parfile
+ </a>
+ </li>
+ </ul>
+</li>
+
+ </ul>
+ </nav>
+ </div>
+
+ <main class="mdl-layout__content">
+ <div class="page-content">
+<h1>Overview</h1>
+
+
+<nav class="toc">
+ <h2>Rule sets</h2>
+ <ul>
+ <li><a href="#debug">debug Rules</a></li>
+ <li><a href="#subpar">Build self-contained python executables.</a></li>
+ </ul>
+</nav>
+
+<h2><a href="./debug.html">debug Rules</a></h2>
+
+<h3>Macros</h3>
+<table class="overview-table">
+ <colgroup>
+ <col class="col-name" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr>
+ <td>
+ <a href="./debug.html#dump">
+ <code>dump</code>
+ </a>
+ </td>
+ <td>
+ <p>Debugging method that recursively prints object fields to stderr</p>
+
+ </td>
+ </tr>
+ </tbody>
+</table>
+<h2><a href="./subpar.html">Build self-contained python executables.</a></h2>
+
+<h3>Rules</h3>
+<table class="overview-table">
+ <colgroup>
+ <col class="col-name" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr>
+ <td>
+ <a href="./subpar.html#parfile">
+ <code>parfile</code>
+ </a>
+ </td>
+ <td>
+ <p>A self-contained, single-file Python program, with a .par file extension.</p>
+
+ </td>
+ </tr>
+ </tbody>
+</table>
+<h3>Macros</h3>
+<table class="overview-table">
+ <colgroup>
+ <col class="col-name" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr>
+ <td>
+ <a href="./subpar.html#par_binary">
+ <code>par_binary</code>
+ </a>
+ </td>
+ <td>
+ <p>An executable Python program.</p>
+
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+
+ </div>
+
+ <footer class="mdl-mini-footer">
+ <div class="mdl-mini-footer__left-section">
+ <div class="mdl-logo">Bazel</div>
+ <ul class="mdl-mini-footer__link-list">
+ <li><a href="http://bazel.io">Home</a></li>
+ <li><a href="https://github.com/bazelbuild">GitHub</a></li>
+ </ul>
+ </div>
+ </footer>
+ </main>
+ </div>
+ </body>
+</html>
diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..de21e1b
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,76 @@
+
+# Overview
+
+
+<nav class="toc">
+ <h2>Rule sets</h2>
+ <ul>
+ <li><a href="#debug">debug Rules</a></li>
+ <li><a href="#subpar">Build self-contained python executables.</a></li>
+ </ul>
+</nav>
+
+<h2><a href="./debug.html">debug Rules</a></h2>
+
+<h3>Macros</h3>
+<table class="overview-table">
+ <colgroup>
+ <col class="col-name" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr>
+ <td>
+ <a href="./debug.html#dump">
+ <code>dump</code>
+ </a>
+ </td>
+ <td>
+ <p>Debugging method that recursively prints object fields to stderr</p>
+
+ </td>
+ </tr>
+ </tbody>
+</table>
+<h2><a href="./subpar.html">Build self-contained python executables.</a></h2>
+
+<h3>Rules</h3>
+<table class="overview-table">
+ <colgroup>
+ <col class="col-name" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr>
+ <td>
+ <a href="./subpar.html#parfile">
+ <code>parfile</code>
+ </a>
+ </td>
+ <td>
+ <p>A self-contained, single-file Python program, with a .par file extension.</p>
+
+ </td>
+ </tr>
+ </tbody>
+</table>
+<h3>Macros</h3>
+<table class="overview-table">
+ <colgroup>
+ <col class="col-name" />
+ <col class="col-description" />
+ </colgroup>
+ <tbody>
+ <tr>
+ <td>
+ <a href="./subpar.html#par_binary">
+ <code>par_binary</code>
+ </a>
+ </td>
+ <td>
+ <p>An executable Python program.</p>
+
+ </td>
+ </tr>
+ </tbody>
+</table>
diff --git a/docs/main.css b/docs/main.css
new file mode 100755
index 0000000..f506e12
--- /dev/null
+++ b/docs/main.css
@@ -0,0 +1,3 @@
+body{background-color:#fafafa}pre,code{font-family:'Liberation Mono', Consolas, Monaco, 'Andale Mono', monospace}pre{background-color:#eee;padding:20px;overflow-x:auto;word-wrap:normal}pre code{overflow-wrap:normal;white-space:pre}code{display:inline-block;font-size:90%;white-space:pre-wrap}.mdl-layout__drawer{background-color:#fff}.mdl-layout__drawer .mdl-layout-title{border-bottom:1px solid #e0e0e0;padding-left:24px}.drawer-nav ul{list-style:none;padding-left:0}.drawer-nav ul li{display:block;padding:0}.drawer-nav ul li ul li a{padding-left:44px;font-weight:400}.drawer-nav ul li a{display:block;flex-shrink:0;padding:15px 0 15px 22px;margin:0;font-weight:600;color:#757575;line-height:1em;text-decoration:none;cursor:pointer}.drawer-nav ul li a:active,.drawer-nav ul li a:hover{background-color:#f0f0f0}.drawer-nav ul li.active a{color:#4caf50;font-weight:500}h1.page-title{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}p.lead{font-size:20px;line-height:32px}table{border-collapse:collapse;border-spacing:0;background-color:#fff;table-layout:auto}table thead th{background-color:#fafafa;border:1px solid #eee;color:#757575;padding:12px 12px 12px 24px;vertical-align:top}table tbody td{border:1px solid #eee;padding:12px 12px 12px 24px;vertical-align:top}table.params-table{width:100%}table.params-table col.col-param{width:25%}table.params-table col.col-description{width:75%}table.overview-table{width:100%}table.overview-table col.col-name{width:25%}table.overview-table col.col-description{width:75%}table.overview-table td p{margin:0}hr{margin-top:80px;margin-bottom:80px}nav.toc{border-left:5px solid #4caf50;padding-left:20px;margin-bottom:48px}nav.toc h1,nav.toc h2{font-size:15px;line-height:16px;padding-bottom:12px;margin-bottom:0;font-weight:400;color:#757575}nav.toc ul{list-style:none;margin-top:0;padding-left:0}nav.toc ul li{font-size:20px;line-height:40px}nav.toc ul li a{color:#4caf50}.page-content{margin-left:auto;margin-right:auto;padding-top:60px;padding-bottom:60px;width:760px}.page-content a{text-decoration:none}.page-content h1{font-size:34px;font-weight:400;line-height:40px;margin-bottom:30px;color:#4caf50}.page-content h2{font-size:24px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}.page-content h3{font-size:20px;font-weight:400;line-height:32px;margin-bottom:30px;color:#4caf50}@media (max-width: 768px){.page-content{width:360px}}@media (min-width: 768px){.page-content{width:760px}}@media (min-width: 1476px){.page-content{width:1160px}}.mdl-mini-footer{padding-left:40px}
+
+/*# sourceMappingURL=main.css.map */
\ No newline at end of file
diff --git a/docs/subpar.html b/docs/subpar.html
index 1bd624d..8f9ffbf 100644
--- a/docs/subpar.html
+++ b/docs/subpar.html
@@ -1,4 +1,5 @@
+
<!--
Documentation generated by Skydoc
-->
@@ -15,7 +16,7 @@
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.1.1/material.green-light_blue.min.css">
<script defer src="https://code.getmdl.io/1.1.1/material.min.js"></script>
- <link rel="stylesheet" href="css/main.css">
+ <link rel="stylesheet" href="./main.css">
</head>
<body>
<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer
@@ -30,17 +31,21 @@
<nav class="drawer-nav">
<ul class="drawer-nav">
+<li><a href="./index.html">Overview</a></li>
<li>
- <a href="debug.html">debug</a>
+ <a href="./debug.html">debug Rules</a>
<ul>
- <li><a href="debug.html#dump">dump</a></li>
</ul>
</li>
+<li><a href="./index.html">Overview</a></li>
<li>
- <a href="subpar.html">subpar</a>
+ <a href="./subpar.html">Build self-contained python executables.</a>
<ul>
- <li><a href="subpar.html#par_binary">par_binary</a></li>
- <li><a href="subpar.html#parfile">parfile</a></li>
+ <li>
+ <a href="./subpar.html#parfile">
+ parfile
+ </a>
+ </li>
</ul>
</li>
@@ -55,9 +60,12 @@
<nav class="toc">
<h2>Rules</h2>
<ul>
- <li><a href="#par_binary">par_binary</a></li>
<li><a href="#parfile">parfile</a></li>
</ul>
+ <h2>Macros</h2>
+ <ul>
+ <li><a href="#par_binary">par_binary</a></li>
+ </ul>
</nav>
<hr>
@@ -69,6 +77,10 @@
<p>par_binary() is a drop-in replacement for py_binary() that also
builds a self-contained, single-file executable for the
application, with a .par file extension.</p>
+<p>The <code>name</code> attribute shouldn't include the <code>.par</code> file extension,
+it's added automatically. So, for a rule like
+<code>par_binary(name="myname")</code>, build the file <code>myname.par</code> by doing
+<code>bazel build //mypackage:myname.par</code></p>
<p>See <a href="http://www.bazel.io/docs/be/python.html#py_binary">py_binary</a>
for arguments and usage.</p>
@@ -84,7 +96,7 @@
<tr id="par_binary.name">
<td><code>name</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#name">Name</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#name">Name</a>; Required</code></p>
<p>A unique name for this rule.</p>
</td>
</tr>
@@ -113,21 +125,21 @@
<tr id="parfile.name">
<td><code>name</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#name">Name</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#name">Name</a>; Required</code></p>
<p>A unique name for this rule.</p>
</td>
</tr>
<tr id="parfile.src">
<td><code>src</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#labels">Label</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Required</code></p>
<p>A py_binary() target</p>
</td>
</tr>
<tr id="parfile.compiler">
<td><code>compiler</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#labels">Label</a>; Optional</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is //compiler:compiler.par</code></p>
<p>Internal use only.</p>
</td>
</tr>
@@ -142,7 +154,7 @@
<tr id="parfile.imports">
<td><code>imports</code></td>
<td>
- <p><code>List of strings; Optional</code></p>
+ <p><code>List of strings; Optional; Default is []</code></p>
<p>List of import directories to be added to the PYTHONPATH.</p>
<p>See <a href="http://www.bazel.io/docs/be/python.html#py_binary.imports">py_binary.imports</a></p>
</td>
@@ -150,7 +162,7 @@
<tr id="parfile.main">
<td><code>main</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#labels">Label</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Required</code></p>
<p>The name of the source file that is the main entry point of
the application.</p>
<p>See <a href="http://www.bazel.io/docs/be/python.html#py_binary.main">py_binary.main</a></p>
@@ -158,6 +170,8 @@
</tr>
</tbody>
</table>
+
+
</div>
<footer class="mdl-mini-footer">
diff --git a/docs/subpar.md b/docs/subpar.md
index f183464..4a3b538 100644
--- a/docs/subpar.md
+++ b/docs/subpar.md
@@ -8,9 +8,12 @@
<nav class="toc">
<h2>Rules</h2>
<ul>
- <li><a href="#par_binary">par_binary</a></li>
<li><a href="#parfile">parfile</a></li>
</ul>
+ <h2>Macros</h2>
+ <ul>
+ <li><a href="#par_binary">par_binary</a></li>
+ </ul>
</nav>
<a name="par_binary"></a>
## par_binary
@@ -25,6 +28,11 @@
builds a self-contained, single-file executable for the
application, with a .par file extension.
+The `name` attribute shouldn't include the `.par` file extension,
+it's added automatically. So, for a rule like
+`par_binary(name="myname")`, build the file `myname.par` by doing
+`bazel build //mypackage:myname.par`
+
See [py_binary](http://www.bazel.io/docs/be/python.html#py_binary)
for arguments and usage.
@@ -42,7 +50,7 @@
<tr id="par_binary.name">
<td><code>name</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#name">Name</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#name">Name</a>; Required</code></p>
<p>A unique name for this rule.</p>
</td>
</tr>
@@ -76,21 +84,21 @@
<tr id="parfile.name">
<td><code>name</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#name">Name</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#name">Name</a>; Required</code></p>
<p>A unique name for this rule.</p>
</td>
</tr>
<tr id="parfile.src">
<td><code>src</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#labels">Label</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Required</code></p>
<p>A py_binary() target</p>
</td>
</tr>
<tr id="parfile.compiler">
<td><code>compiler</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#labels">Label</a>; Optional</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Optional; Default is //compiler:compiler.par</code></p>
<p>Internal use only.</p>
</td>
</tr>
@@ -105,7 +113,7 @@
<tr id="parfile.imports">
<td><code>imports</code></td>
<td>
- <p><code>List of strings; Optional</code></p>
+ <p><code>List of strings; Optional; Default is []</code></p>
<p>List of import directories to be added to the PYTHONPATH.</p>
<p>See <a href="http://www.bazel.io/docs/be/python.html#py_binary.imports">py_binary.imports</a></p>
</td>
@@ -113,7 +121,7 @@
<tr id="parfile.main">
<td><code>main</code></td>
<td>
- <p><code><a href="http://bazel.io/docs/build-ref.html#labels">Label</a>; Required</code></p>
+ <p><code><a href="https://bazel.build/docs/build-ref.html#labels">Label</a>; Required</code></p>
<p>The name of the source file that is the main entry point of
the application.</p>
<p>See <a href="http://www.bazel.io/docs/be/python.html#py_binary.main">py_binary.main</a></p>
diff --git a/subpar.bzl b/subpar.bzl
index 4361f50..44e162e 100644
--- a/subpar.bzl
+++ b/subpar.bzl
@@ -158,9 +158,13 @@
builds a self-contained, single-file executable for the
application, with a .par file extension.
+ The `name` attribute shouldn't include the `.par` file extension,
+ it's added automatically. So, for a rule like
+ `par_binary(name="myname")`, build the file `myname.par` by doing
+ `bazel build //mypackage:myname.par`
+
See [py_binary](http://www.bazel.io/docs/be/python.html#py_binary)
for arguments and usage.
-
"""
native.py_binary(name=name, **kwargs)
main = kwargs.get('main', name + '.py')
diff --git a/update_docs.sh b/update_docs.sh
index dfba97c..22ca73e 100755
--- a/update_docs.sh
+++ b/update_docs.sh
@@ -19,4 +19,3 @@
bazel build //docs/...
unzip -d docs/ -o bazel-bin/docs/docs-md-skydoc.zip
unzip -d docs/ -o bazel-bin/docs/docs-html-skydoc.zip
-perl -i -pe 's|href="/css/main.css"|href="css/main.css"|' docs/*.html
