Deploying to gh-pages from @ 9232645 🚀

applets/api/applet.html

@@ -201,7 +201,7 @@
           <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
         </button>
       </div>
-      <label class="toc-overlay-icon toc-header-icon" for="__toc">
+      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
         <div class="visually-hidden">Toggle table of contents sidebar</div>
         <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
       </label>
@@ -390,7 +390,7 @@
               <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
             </button>
           </div>
-          <label class="toc-overlay-icon toc-content-icon" for="__toc">
+          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
             <div class="visually-hidden">Toggle table of contents sidebar</div>
             <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
           </label>
@@ -404,114 +404,6 @@ <h1><code class="docutils literal notranslate"><span class="pre">squishy.applets
 <p class="admonition-title">Todo</p>
 <p>Flesh this out</p>
 </div>
-<dl class="py class">
-<dt class="sig sig-object py" id="squishy.applets.SquishyApplet">
-<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">squishy.applets.</span></span><span class="sig-name descname"><span class="pre">SquishyApplet</span></span><a class="headerlink" href="#squishy.applets.SquishyApplet" title="Link to this definition">¶</a></dt>
-<dd><p>Squishy applet base class.</p>
-<p>This is the abstract base class that is used
-to implement any possible applet for squishy.</p>
-<p>It represents a combination of client-side python,
-and gateware that will run the the hardware platform.</p>
-<p>Users can then invoke the build and execution of implemented
-applets by name.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Variables<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>preview</strong> (<a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><em>bool</em></a>) – If the applet is a preview/pre-release applet.</p></li>
-<li><p><strong>pretty_name</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A pretty string name of the applet.</p></li>
-<li><p><strong>short_help</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A short section of help for the applet.</p></li>
-<li><p><strong>help</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A longer more detailed help string.</p></li>
-<li><p><strong>description</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – A brief description about the applet.</p></li>
-<li><p><strong>hardware_rev</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a><em>, </em><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#tuple" title="(in Python v3.12)"><em>tuple</em></a>) – A single string, or a tuple of strings for supported hardware revisions</p></li>
-</ul>
-</dd>
-</dl>
-<dl class="py method">
-<dt class="sig sig-object py" id="squishy.applets.SquishyApplet.supported_platform">
-<span class="sig-name descname"><span class="pre">supported_platform</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">platform</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><span class="pre">str</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)"><span class="pre">bool</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.supported_platform" title="Link to this definition">¶</a></dt>
-<dd><p>Check to see if the given platform is supported</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>platform</strong> (<a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.12)"><em>str</em></a>) – The platform to check</p>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>True if the applet supports the platform, otherwise False.</p>
-</dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#bool" title="(in Python v3.12)">bool</a></p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="squishy.applets.SquishyApplet.show_help">
-<span class="sig-name descname"><span class="pre">show_help</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.show_help" title="Link to this definition">¶</a></dt>
-<dd><p>Shows applets built-in help</p>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="squishy.applets.SquishyApplet.init_applet">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">init_applet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.12)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">AppletElaboratable</span></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.init_applet" title="Link to this definition">¶</a></dt>
-<dd><p>Applet Initialization</p>
-<p>Called to initialize the applet prior to
-the applet being built and ran</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>args</strong> (<em>argsparse.Namespace</em>) – Any command line arguments passed.</p>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>The applet logic/elaboratable</p>
-</dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p>AppletElaboratable</p>
-</dd>
-<dt class="field-even">Raises<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.12)"><strong>NotImplementedError</strong></a> – The abstract method must be implemented by the applet</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="squishy.applets.SquishyApplet.register_args">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">register_args</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parser</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser" title="(in Python v3.12)"><span class="pre">ArgumentParser</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.12)"><span class="pre">None</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.register_args" title="Link to this definition">¶</a></dt>
-<dd><p>Applet argument registration</p>
-<p>Called to register any applet specific arguments.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>parser</strong> (<a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.ArgumentParser" title="(in Python v3.12)"><em>argparse.ArgumentParser</em></a>) – The root argparse parser.</p>
-</dd>
-<dt class="field-even">Raises<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.12)"><strong>NotImplementedError</strong></a> – The abstract method must be implemented by the applet</p>
-</dd>
-</dl>
-</dd></dl>
-
-<dl class="py method">
-<dt class="sig sig-object py" id="squishy.applets.SquishyApplet.run">
-<em class="property"><span class="pre">abstract</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">run</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="device.html#squishy.core.device.SquishyHardwareDevice" title="squishy.core.device.SquishyHardwareDevice"><span class="pre">SquishyHardwareDevice</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">args</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://docs.python.org/3/library/argparse.html#argparse.Namespace" title="(in Python v3.12)"><span class="pre">Namespace</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)"><span class="pre">int</span></a></span></span><a class="headerlink" href="#squishy.applets.SquishyApplet.run" title="Link to this definition">¶</a></dt>
-<dd><p>Applet run step</p>
-<p>Called to run any specialized machinery for the applet.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><ul class="simple">
-<li><p><strong>device</strong> (<a class="reference internal" href="device.html#squishy.core.device.SquishyHardwareDevice" title="squishy.core.device.SquishyHardwareDevice"><em>squishy.core.device.SquishyHardwareDevice</em></a>) – The target squishy device.</p></li>
-<li><p><strong>args</strong> (<em>argsparse.Namespace</em>) – Any command line arguments passed.</p></li>
-</ul>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p>0 if run was successful, otherwise an error code.</p>
-</dd>
-<dt class="field-odd">Return type<span class="colon">:</span></dt>
-<dd class="field-odd"><p><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.12)">int</a></p>
-</dd>
-<dt class="field-even">Raises<span class="colon">:</span></dt>
-<dd class="field-even"><p><a class="reference external" href="https://docs.python.org/3/library/exceptions.html#NotImplementedError" title="(in Python v3.12)"><strong>NotImplementedError</strong></a> – The abstract method must be implemented by the applet</p>
-</dd>
-</dl>
-</dd></dl>
-
-</dd></dl>
-
 </section>
 
     <script type="text/javascript">
@@ -563,34 +455,8 @@ <h1><code class="docutils literal notranslate"><span class="pre">squishy.applets
 
       </footer>
     </div>
-    <aside class="toc-drawer">
-
+    <aside class="toc-drawer no-toc">
 
-      <div class="toc-sticky toc-scroll">
-        <div class="toc-title-container">
-          <span class="toc-title">
-            On this page
-          </span>
-        </div>
-        <div class="toc-tree-container">
-          <div class="toc-tree">
-            <ul>
-<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">squishy.applets.SquishyApplet</span></code></a><ul>
-<li><a class="reference internal" href="#squishy.applets.SquishyApplet"><code class="docutils literal notranslate"><span class="pre">SquishyApplet</span></code></a><ul>
-<li><a class="reference internal" href="#squishy.applets.SquishyApplet.supported_platform"><code class="docutils literal notranslate"><span class="pre">SquishyApplet.supported_platform()</span></code></a></li>
-<li><a class="reference internal" href="#squishy.applets.SquishyApplet.show_help"><code class="docutils literal notranslate"><span class="pre">SquishyApplet.show_help()</span></code></a></li>
-<li><a class="reference internal" href="#squishy.applets.SquishyApplet.init_applet"><code class="docutils literal notranslate"><span class="pre">SquishyApplet.init_applet()</span></code></a></li>
-<li><a class="reference internal" href="#squishy.applets.SquishyApplet.register_args"><code class="docutils literal notranslate"><span class="pre">SquishyApplet.register_args()</span></code></a></li>
-<li><a class="reference internal" href="#squishy.applets.SquishyApplet.run"><code class="docutils literal notranslate"><span class="pre">SquishyApplet.run()</span></code></a></li>
-</ul>
-</li>
-</ul>
-</li>
-</ul>
-
-          </div>
-        </div>
-      </div>
 
 
     </aside>