Skip to content

Commit da356d1

Browse files
yixu34yixu34
authored
Yi/fix broken doc content (#37)
* Revert "Refresh documentation (#33)" This reverts commit 8f68c3f. * Restore docs
1 parent 8f68c3f commit da356d1

File tree

82 files changed

+1312
-4714
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+1312
-4714
lines changed

‎docs/.nojekyll‎

Whitespace-only changes.

‎docs/_static/favicon.ico‎

1.12 KB
Binary file not shown.

‎docs/api/launch/cli/bin/index.html‎

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,12 @@
161161
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
162162
<ul>
163163
<li class="toctree-l1 has-children"><a class="reference internal" href="../../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
164-
<li class="toctree-l2"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
165164
<li class="toctree-l2"><a class="reference internal" href="../../request_validation/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.request_validation</span></code></a></li>
166165
</ul>
167166
</li>
168-
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../guides/index.html">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
169-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/getting_started.html">Introduction to Scale Launch</a></li>
170-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/registering_your_code.html">Registering your code</a></li>
171-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/deploying_your_code.html">Deploying your code</a></li>
172-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/integrations.html">Integrations</a></li>
173-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/troubleshooting.html">Troubleshooting</a></li>
174-
</ul>
175-
</li>
167+
<li class="toctree-l1"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
168+
<li class="toctree-l1"><a class="reference internal" href="../../pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.pipeline</span></code></a></li>
169+
<li class="toctree-l1"><a class="reference internal" href="../../clientlib/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.clientlib</span></code></a></li>
176170
</ul>
177171

178172
</div>
@@ -220,23 +214,27 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
220214
</colgroup>
221215
<tbody>
222216
<tr class="row-odd"><td><p><a class="reference internal" href="#launch.cli.bin.entry_point" title="launch.cli.bin.entry_point"><code class="xref py py-obj docutils literal notranslate"><span class="pre">entry_point</span></code></a>(ctx, **kwargs)</p></td>
223-
<td><p>This is the command line interface (CLI) package for Scale Launch.</p></td>
217+
<td><p>Launch CLI</p></td>
224218
</tr>
225219
</tbody>
226220
</table>
227221
</div>
228222
<dl class="py function">
229223
<dt class="sig sig-object py" id="launch.cli.bin.entry_point">
230224
<span class="sig-prename descclassname"><span class="pre">launch.cli.bin.</span></span><span class="sig-name descname"><span class="pre">entry_point</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#launch.cli.bin.entry_point" title="Permalink to this definition">#</a></dt>
231-
<dd><p>This is the command line interface (CLI) package for Scale Launch.</p>
232-
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>██╗ █████╗ ██╗ ██╗███╗ ██╗ ██████╗██╗ ██╗
225+
<dd><p>Launch CLI</p>
226+
<blockquote>
227+
<div><p></p>
228+
</div></blockquote>
229+
<p>██╗ █████╗ ██╗ ██╗███╗ ██╗ ██████╗██╗ ██╗
233230
██║ ██╔══██╗██║ ██║████╗ ██║██╔════╝██║ ██║
234231
██║ ███████║██║ ██║██╔██╗ ██║██║ ███████║
235232
██║ ██╔══██║██║ ██║██║╚██╗██║██║ ██╔══██║
236233
███████╗██║ ██║╚██████╔╝██║ ╚████║╚██████╗██║ ██║
237-
╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚═╝ ╚═╝
238-
</pre></div>
239-
</div>
234+
╚══════╝╚═╝ ╚═╝ ╚═════╝ ╚═╝ ╚═══╝ ╚═════╝╚═╝ ╚═╝</p>
235+
<blockquote>
236+
<div><p><cite>scale-launch</cite> is a command line interface to interact with Scale Launch</p>
237+
</div></blockquote>
240238
</dd></dl>
241239

242240
</section>

‎docs/api/launch/cli/bundles/index.html‎

Lines changed: 7 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,12 @@
161161
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
162162
<ul>
163163
<li class="toctree-l1 has-children"><a class="reference internal" href="../../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
164-
<li class="toctree-l2"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
165164
<li class="toctree-l2"><a class="reference internal" href="../../request_validation/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.request_validation</span></code></a></li>
166165
</ul>
167166
</li>
168-
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../guides/index.html">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
169-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/getting_started.html">Introduction to Scale Launch</a></li>
170-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/registering_your_code.html">Registering your code</a></li>
171-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/deploying_your_code.html">Deploying your code</a></li>
172-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/integrations.html">Integrations</a></li>
173-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/troubleshooting.html">Troubleshooting</a></li>
174-
</ul>
175-
</li>
167+
<li class="toctree-l1"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
168+
<li class="toctree-l1"><a class="reference internal" href="../../pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.pipeline</span></code></a></li>
169+
<li class="toctree-l1"><a class="reference internal" href="../../clientlib/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.clientlib</span></code></a></li>
176170
</ul>
177171

178172
</div>
@@ -219,11 +213,11 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
219213
<col style="width: 90%" />
220214
</colgroup>
221215
<tbody>
222-
<tr class="row-odd"><td><p><a class="reference internal" href="#launch.cli.bundles.bundles" title="launch.cli.bundles.bundles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bundles</span></code></a>(ctx)</p></td>
216+
<tr class="row-odd"><td><p><a class="reference internal" href="#launch.cli.bundles.bundles" title="launch.cli.bundles.bundles"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bundles</span></code></a>()</p></td>
223217
<td><p>Bundles is a wrapper around model bundles in Scale Launch</p></td>
224218
</tr>
225219
<tr class="row-even"><td><p><a class="reference internal" href="#launch.cli.bundles.delete_bundle" title="launch.cli.bundles.delete_bundle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">delete_bundle</span></code></a>(ctx, bundle_name)</p></td>
226-
<td><p>Deletes a model bundle.</p></td>
220+
<td><p>Delete a model bundle</p></td>
227221
</tr>
228222
<tr class="row-odd"><td><p><a class="reference internal" href="#launch.cli.bundles.get_bundle" title="launch.cli.bundles.get_bundle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_bundle</span></code></a>(ctx, bundle_name)</p></td>
229223
<td><p>Print bundle info</p></td>
@@ -236,19 +230,14 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
236230
</div>
237231
<dl class="py function">
238232
<dt class="sig sig-object py" id="launch.cli.bundles.bundles">
239-
<span class="sig-prename descclassname"><span class="pre">launch.cli.bundles.</span></span><span class="sig-name descname"><span class="pre">bundles</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#launch.cli.bundles.bundles" title="Permalink to this definition">#</a></dt>
233+
<span class="sig-prename descclassname"><span class="pre">launch.cli.bundles.</span></span><span class="sig-name descname"><span class="pre">bundles</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#launch.cli.bundles.bundles" title="Permalink to this definition">#</a></dt>
240234
<dd><p>Bundles is a wrapper around model bundles in Scale Launch</p>
241-
<dl class="field-list simple">
242-
<dt class="field-odd">Parameters</dt>
243-
<dd class="field-odd"><p><strong>ctx</strong> (<em>click.Context</em>) – </p>
244-
</dd>
245-
</dl>
246235
</dd></dl>
247236

248237
<dl class="py function">
249238
<dt class="sig sig-object py" id="launch.cli.bundles.delete_bundle">
250239
<span class="sig-prename descclassname"><span class="pre">launch.cli.bundles.</span></span><span class="sig-name descname"><span class="pre">delete_bundle</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">bundle_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#launch.cli.bundles.delete_bundle" title="Permalink to this definition">#</a></dt>
251-
<dd><p>Deletes a model bundle.</p>
240+
<dd><p>Delete a model bundle</p>
252241
<dl class="field-list simple">
253242
<dt class="field-odd">Parameters</dt>
254243
<dd class="field-odd"><ul class="simple">

‎docs/api/launch/cli/client/index.html‎

Lines changed: 3 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,12 @@
161161
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
162162
<ul>
163163
<li class="toctree-l1 has-children"><a class="reference internal" href="../../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
164-
<li class="toctree-l2"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
165164
<li class="toctree-l2"><a class="reference internal" href="../../request_validation/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.request_validation</span></code></a></li>
166165
</ul>
167166
</li>
168-
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../guides/index.html">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
169-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/getting_started.html">Introduction to Scale Launch</a></li>
170-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/registering_your_code.html">Registering your code</a></li>
171-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/deploying_your_code.html">Deploying your code</a></li>
172-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/integrations.html">Integrations</a></li>
173-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/troubleshooting.html">Troubleshooting</a></li>
174-
</ul>
175-
</li>
167+
<li class="toctree-l1"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
168+
<li class="toctree-l1"><a class="reference internal" href="../../pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.pipeline</span></code></a></li>
169+
<li class="toctree-l1"><a class="reference internal" href="../../clientlib/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.clientlib</span></code></a></li>
176170
</ul>
177171

178172
</div>

‎docs/api/launch/cli/endpoints/index.html‎

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -161,18 +161,12 @@
161161
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
162162
<ul>
163163
<li class="toctree-l1 has-children"><a class="reference internal" href="../../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch</span></code></a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
164-
<li class="toctree-l2"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
165164
<li class="toctree-l2"><a class="reference internal" href="../../request_validation/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.request_validation</span></code></a></li>
166165
</ul>
167166
</li>
168-
<li class="toctree-l1 has-children"><a class="reference internal" href="../../../../guides/index.html">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle child pages in navigation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
169-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/getting_started.html">Introduction to Scale Launch</a></li>
170-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/registering_your_code.html">Registering your code</a></li>
171-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/deploying_your_code.html">Deploying your code</a></li>
172-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/integrations.html">Integrations</a></li>
173-
<li class="toctree-l2"><a class="reference internal" href="../../../../guides/troubleshooting.html">Troubleshooting</a></li>
174-
</ul>
175-
</li>
167+
<li class="toctree-l1"><a class="reference internal" href="../index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.cli</span></code></a></li>
168+
<li class="toctree-l1"><a class="reference internal" href="../../pipeline/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.pipeline</span></code></a></li>
169+
<li class="toctree-l1"><a class="reference internal" href="../../clientlib/index.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">launch.clientlib</span></code></a></li>
176170
</ul>
177171

178172
</div>
@@ -229,7 +223,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
229223
<td><p>List all of your Endpoints</p></td>
230224
</tr>
231225
<tr class="row-even"><td><p><a class="reference internal" href="#launch.cli.endpoints.read_endpoint_creation_logs" title="launch.cli.endpoints.read_endpoint_creation_logs"><code class="xref py py-obj docutils literal notranslate"><span class="pre">read_endpoint_creation_logs</span></code></a>(ctx, endpoint_name)</p></td>
232-
<td><p>Reads the creation logs for an endpoint</p></td>
226+
<td><p>Delete a model endpoint</p></td>
233227
</tr>
234228
</tbody>
235229
</table>
@@ -273,7 +267,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
273267
<dl class="py function">
274268
<dt class="sig sig-object py" id="launch.cli.endpoints.read_endpoint_creation_logs">
275269
<span class="sig-prename descclassname"><span class="pre">launch.cli.endpoints.</span></span><span class="sig-name descname"><span class="pre">read_endpoint_creation_logs</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">ctx</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">endpoint_name</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#launch.cli.endpoints.read_endpoint_creation_logs" title="Permalink to this definition">#</a></dt>
276-
<dd><p>Reads the creation logs for an endpoint</p>
270+
<dd><p>Delete a model endpoint</p>
277271
<dl class="field-list simple">
278272
<dt class="field-odd">Parameters</dt>
279273
<dd class="field-odd"><ul class="simple">

0 commit comments

Comments
 (0)