docs: fix rendering FastBuild and Repo API docs (#1118)

tilt-dev · Feb 5, 2019 · ced30e9 · ced30e9
1 parent 1471a9f
commit ced30e9
Show file tree

Hide file tree

Showing 7 changed files with 120 additions and 13 deletions.
diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html
@@ -190,26 +190,85 @@
 <dd><p>The result of executing a command on your local system</p>
 </dd></dl>
 
+<dl class="class">
+<dt id="api.FastBuild">
+<em class="property">class </em><code class="descclassname">api.</code><code class="descname">FastBuild</code><a class="headerlink" href="#api.FastBuild" title="Permalink to this definition">¶</a></dt>
+<dd><p>An image that was created with <code class="docutils literal notranslate"><span class="pre">`fast_build`</span></code></p>
+<dl class="method">
+<dt id="api.FastBuild.add">
+<code class="descname">add</code><span class="sig-paren">(</span><em>dest</em><span class="sig-paren">)</span><a class="headerlink" href="#api.FastBuild.add" title="Permalink to this definition">¶</a></dt>
+<dd><p>Adds the content from <code class="docutils literal notranslate"><span class="pre">src</span></code> into the image at path <code class="docutils literal notranslate"><span class="pre">dest</span></code>.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.FastBuild" title="api.FastBuild"><code class="xref py py-class docutils literal notranslate"><span class="pre">FastBuild</span></code></a></td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="api.FastBuild.run">
+<code class="descname">run</code><span class="sig-paren">(</span><em>trigger=[]</em><span class="sig-paren">)</span><a class="headerlink" href="#api.FastBuild.run" title="Permalink to this definition">¶</a></dt>
+<dd><p>Runs <code class="docutils literal notranslate"><span class="pre">cmd</span></code> as a build step in the image.</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><strong>cmd</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – A shell command.</li>
+<li><strong>trigger</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Union</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">List</span></code>[<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>], <code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>]) – If the <code class="docutils literal notranslate"><span class="pre">trigger</span></code> argument is specified, the build step is only run on changes to the given file(s).</li>
+</ul>
+</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><p class="first last"><code class="docutils literal notranslate"><span class="pre">None</span></code></p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+</dd></dl>
+
 <dl class="class">
 <dt id="api.LocalPath">
 <em class="property">class </em><code class="descclassname">api.</code><code class="descname">LocalPath</code><a class="headerlink" href="#api.LocalPath" title="Permalink to this definition">¶</a></dt>
 <dd><p>A path on disk</p>
 </dd></dl>
 
-<dl class="function">
-<dt id="api.blob">
-<code class="descclassname">api.</code><code class="descname">blob</code><span class="sig-paren">(</span><em>input</em><span class="sig-paren">)</span><a class="headerlink" href="#api.blob" title="Permalink to this definition">¶</a></dt>
-<dd><p>Creates a blob that wraps the provided string. Useful for passing strings in to functions like <code class="docutils literal notranslate"><span class="pre">k8s_yaml</span></code></p>
+<dl class="class">
+<dt id="api.Repo">
+<em class="property">class </em><code class="descclassname">api.</code><code class="descname">Repo</code><a class="headerlink" href="#api.Repo" title="Permalink to this definition">¶</a></dt>
+<dd><p>Represents a version control repository</p>
+<dl class="method">
+<dt id="api.Repo.path">
+<code class="descname">path</code><span class="sig-paren">(</span><em>path</em><span class="sig-paren">)</span><a class="headerlink" href="#api.Repo.path" title="Permalink to this definition">¶</a></dt>
+<dd><p>Returns the absolute path to the file specified at <code class="docutils literal notranslate"><span class="pre">path</span></code> in the repo.
+path must be a relative path.</p>
+<p>Respects <code class="docutils literal notranslate"><span class="pre">.gitignore</span></code>.</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.Blob" title="api.Blob"><code class="xref py py-class docutils literal notranslate"><span class="pre">Blob</span></code></a></td>
+<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>path</strong> (<code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code>) – relative path in repository</td>
+</tr>
+<tr class="field-even field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.LocalPath" title="api.LocalPath"><code class="xref py py-class docutils literal notranslate"><span class="pre">LocalPath</span></code></a></td>
+</tr>
+<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">A LocalPath resource, representing a local path on disk.</td>
 </tr>
 </tbody>
 </table>
 </dd></dl>
 
+</dd></dl>
+
+<dl class="class">
+<dt id="api.Yaml">
+<em class="property">class </em><code class="descclassname">api.</code><code class="descname">Yaml</code><a class="headerlink" href="#api.Yaml" title="Permalink to this definition">¶</a></dt>
+<dd><p>A string that represents YAML that can be parsed</p>
+</dd></dl>
+
 <dl class="function">
 <dt id="api.docker_build">
 <code class="descclassname">api.</code><code class="descname">docker_build</code><span class="sig-paren">(</span><em>ref</em>, <em>context</em>, <em>build_args={}</em>, <em>dockerfile='Dockerfile'</em>, <em>dockerfile_contents=''</em><span class="sig-paren">)</span><a class="headerlink" href="#api.docker_build" title="Permalink to this definition">¶</a></dt>
@@ -259,7 +318,7 @@
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">FastBuild</span></code></td>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.FastBuild" title="api.FastBuild"><code class="xref py py-class docutils literal notranslate"><span class="pre">FastBuild</span></code></a></td>
 </tr>
 </tbody>
 </table>
@@ -372,7 +431,7 @@
 <col class="field-name" />
 <col class="field-body" />
 <tbody valign="top">
-<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><code class="xref py py-class docutils literal notranslate"><span class="pre">Repo</span></code></td>
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.Repo" title="api.Repo"><code class="xref py py-class docutils literal notranslate"><span class="pre">Repo</span></code></a></td>
 </tr>
 </tbody>
 </table>
@@ -394,6 +453,20 @@
 </table>
 </dd></dl>
 
+<dl class="function">
+<dt id="api.yaml">
+<code class="descclassname">api.</code><code class="descname">yaml</code><span class="sig-paren">(</span><em>contents</em><span class="sig-paren">)</span><a class="headerlink" href="#api.yaml" title="Permalink to this definition">¶</a></dt>
+<dd><p>Creates a Yaml object that wraps the provided string. Useful for passing strings in to functions that expect YAML like <code class="docutils literal notranslate"><span class="pre">k8s_yaml</span></code></p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Return type:</th><td class="field-body"><a class="reference internal" href="#api.Yaml" title="api.Yaml"><code class="xref py py-class docutils literal notranslate"><span class="pre">Yaml</span></code></a></td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </div>
 
 

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -191,11 +191,17 @@ <h1 id="index">Index</h1>
  | <a href="#H"><strong>H</strong></a>
  | <a href="#K"><strong>K</strong></a>
  | <a href="#L"><strong>L</strong></a>
+ | <a href="#P"><strong>P</strong></a>
  | <a href="#R"><strong>R</strong></a>
+ | <a href="#Y"><strong>Y</strong></a>
 
 </div>
 <h2 id="A">A</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.FastBuild.add">add() (api.FastBuild method)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#module-api">api (module)</a>
 </li>
@@ -206,10 +212,6 @@ <h2 id="B">B</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#api.Blob">Blob (class in api)</a>
-</li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="api.html#api.blob">blob() (in module api)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -230,6 +232,8 @@ <h2 id="F">F</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#api.fast_build">fast_build() (in module api)</a>
+</li>
+      <li><a href="api.html#api.FastBuild">FastBuild (class in api)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -270,10 +274,36 @@ <h2 id="L">L</h2>
   </ul></td>
 </tr></table>
 
+<h2 id="P">P</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.Repo.path">path() (api.Repo method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
 <h2 id="R">R</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#api.read_file">read_file() (in module api)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.Repo">Repo (class in api)</a>
+</li>
+      <li><a href="api.html#api.FastBuild.run">run() (api.FastBuild method)</a>
+</li>
+  </ul></td>
+</tr></table>
+
+<h2 id="Y">Y</h2>
+<table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.Yaml">Yaml (class in api)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.yaml">yaml() (in module api)</a>
 </li>
   </ul></td>
 </tr></table>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv