ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source 
Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2023-12-05 16:25:51 -08:00
parent 3467a5d5dd
commit 43cc9d18b6
2585 changed files with 705361 additions and 171748 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/html/_autosummary/kittycad.api.modeling.modeling_commands_ws.asyncio.html
View File

@ -13,7 +13,7 @@
<meta name="twitter:card" content="summary_large_image" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.api.modeling.modeling_commands_ws.asyncio &mdash; kittycad v0.4.6 documentation</title>
<title>kittycad.api.modeling.modeling_commands_ws.asyncio &mdash; kittycad v0.5.9 documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@ -25,7 +25,7 @@
<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=80626fd4"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js?v=19ad864f"></script>
<script src="../_static/doctools.js?v=888ff710"></script>
<script src="../_static/sphinx_highlight.js?v=4825356b"></script>
<script src="../_static/clipboard.min.js?v=a7894cd8"></script>
@ -49,7 +49,7 @@
kittycad
</a>
<div class="version">
v0.4.6
v0.5.9
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@ -72,11 +72,11 @@
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.hidden.html">kittycad.api.hidden</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.api.meta.html">kittycad.api.meta</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="kittycad.api.modeling.html">kittycad.api.modeling</a><ul class="current">
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.modeling.cmd.html">kittycad.api.modeling.cmd</a></li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.api.modeling.cmd_batch.html">kittycad.api.modeling.cmd_batch</a></li>
<li class="toctree-l3 current"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.html">kittycad.api.modeling.modeling_commands_ws</a><ul class="current">
<li class="toctree-l4 current"><a class="current reference internal" href="#">kittycad.api.modeling.modeling_commands_ws.asyncio</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.sync.html">kittycad.api.modeling.modeling_commands_ws.sync</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.WebSocket.html">kittycad.api.modeling.modeling_commands_ws.WebSocket</a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.html#kittycad.api.modeling.modeling_commands_ws.WebSocket"><code class="docutils literal notranslate"><span class="pre">WebSocket</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.html#kittycad.api.modeling.modeling_commands_ws._get_kwargs"><code class="docutils literal notranslate"><span class="pre">_get_kwargs()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.html#kittycad.api.modeling.modeling_commands_ws.asyncio"><code class="docutils literal notranslate"><span class="pre">asyncio()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="kittycad.api.modeling.modeling_commands_ws.html#kittycad.api.modeling.modeling_commands_ws.sync"><code class="docutils literal notranslate"><span class="pre">sync()</span></code></a></li>
@ -125,7 +125,7 @@
<h1>kittycad.api.modeling.modeling_commands_ws.asyncio<a class="headerlink" href="#kittycad-api-modeling-modeling-commands-ws-asyncio" title="Permalink to this heading"></a></h1>
<dl class="py function">
<dt class="sig sig-object py" id="kittycad.api.modeling.modeling_commands_ws.asyncio">
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.modeling.modeling_commands_ws.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unlocked_framerate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_res_height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_res_width</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/modeling/modeling_commands_ws.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/modeling/modeling_commands_ws.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.modeling.modeling_commands_ws.asyncio" title="Permalink to this definition"></a></dt>
<em class="property"><span class="k"><span class="pre">async</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.api.modeling.modeling_commands_ws.</span></span><span class="sig-name descname"><span class="pre">asyncio</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">fps</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">unlocked_framerate</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_res_height</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">video_res_width</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">webrtc</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/api/modeling/modeling_commands_ws.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/api/modeling/modeling_commands_ws.html#asyncio"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.api.modeling.modeling_commands_ws.asyncio" title="Permalink to this definition"></a></dt>
<dd><p>Pass those commands to the engine via websocket, and pass responses back to the client. Basically, this is a websocket proxy between the frontend/client and the engine.</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>