docs: document hot_reload (#1121)

tilt-dev · Feb 5, 2019 · ee57186 · ee57186
1 parent 8be1950
commit ee57186
Show file tree

Hide file tree

Showing 7 changed files with 26 additions and 1 deletion.
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
@@ -208,6 +208,21 @@
 </table>
 </dd></dl>
 
+<dl class="method">
+<dt id="api.FastBuild.hot_reload">
+<code class="descname">hot_reload</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#api.FastBuild.hot_reload" title="Permalink to this definition">¶</a></dt>
+<dd><p>Setting this on a <code class="docutils literal notranslate"><span class="pre">FastBuild</span></code> image tells Tilt that this container knows how to automatically reload any changes in the container. As a result there is no need to restart it.</p>
+<p>This is useful for containers that run something like nodemon or webpack Hot Module Replacement to update running processes quickly.</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"><code class="docutils literal notranslate"><span class="pre">None</span></code></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>

diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -242,6 +242,10 @@ <h2 id="H">H</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="api.html#api.helm">helm() (in module api)</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="api.html#api.FastBuild.hot_reload">hot_reload() (api.FastBuild method)</a>
 </li>
   </ul></td>
 </tr></table>

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/api/api.py b/docs/api/api.py
@@ -59,6 +59,12 @@ def run(cmd: str, trigger: Union[List[str], str] = []) -> None:
     """
     pass
 
+  def hot_reload() -> None:
+    """Setting this on a ``FastBuild`` image tells Tilt that this container knows how to automatically reload any changes in the container. As a result there is no need to restart it.
+
+    This is useful for containers that run something like nodemon or webpack Hot Module Replacement to update running processes quickly."""
+    pass
+
 
 def fast_build(img_name: str, dockerfile_path: str, entrypoint: str = "") -> FastBuild:
   """Initiates a docker image build that supports ``add`` s and ``run`` s, and that uses a cache for subsequent builds.