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

I HAVE GENERATED YOUR NEW DOCS!

Browse Source
This commit is contained in:
github-actions[bot]
2023-05-08 20:06:56 +00:00
parent f933b716f4
commit fa2b411b78
2603 changed files with 36412 additions and 35438 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
docs/html/_autosummary/kittycad.models.unit_data_format.UnitDataFormat.html
View File

@ -1,14 +1,19 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<meta property="og:title" content="kittycad.models.unit_data_format.UnitDataFormat" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.models.unit_data_format.UnitDataFormat.html" />
<meta property="og:site_name" content="kittycad" />
<meta property="og:image:width" content="1146" />
<meta property="og:image:height" content="600" />
<meta property="og:image" content="/_images/social_previews/summary__autosummary_kittycad.models.unit_data_format.UnitDataFormat_86650429.png" />
<meta property="og:image:alt" content="" />
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:title" content="kittycad.models.unit_data_format.UnitDataFormat" />
<meta property="og:type" content="website" />
<meta property="og:url" content="_autosummary/kittycad.models.unit_data_format.UnitDataFormat.html" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>kittycad.models.unit_data_format.UnitDataFormat &mdash; kittycad v0.3.9 documentation</title>
<title>kittycad.models.unit_data_format.UnitDataFormat &mdash; kittycad v0.4.0 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" />
@ -18,10 +23,11 @@
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script src="../_static/js/theme.js"></script>
@ -43,7 +49,7 @@
kittycad
</a>
<div class="version">
v0.3.9
v0.4.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
@ -166,7 +172,11 @@
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_concentration_format.html">kittycad.models.unit_concentration_format</a></li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_data_conversion.html">kittycad.models.unit_data_conversion</a></li>
<li class="toctree-l2 current"><a class="reference internal" href="kittycad.models.unit_data_format.html">kittycad.models.unit_data_format</a><ul class="current">
<li class="toctree-l3 current"><a class="current reference internal" href="#">kittycad.models.unit_data_format.UnitDataFormat</a></li>
<li class="toctree-l3 current"><a class="current reference internal" href="#">kittycad.models.unit_data_format.UnitDataFormat</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#kittycad.models.unit_data_format.UnitDataFormat"><code class="docutils literal notranslate"><span class="pre">UnitDataFormat</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="kittycad.models.unit_data_format.html#kittycad.models.unit_data_format.UnitDataFormat"><code class="docutils literal notranslate"><span class="pre">UnitDataFormat</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="kittycad.models.unit_data_transfer_rate_conversion.html">kittycad.models.unit_data_transfer_rate_conversion</a></li>
@ -247,11 +257,11 @@
<div itemprop="articleBody">
<section id="kittycad-models-unit-data-format-unitdataformat">
<h1>kittycad.models.unit_data_format.UnitDataFormat<a class="headerlink" href="#kittycad-models-unit-data-format-unitdataformat" title="Permalink to this headline"></a></h1>
<h1>kittycad.models.unit_data_format.UnitDataFormat<a class="headerlink" href="#kittycad-models-unit-data-format-unitdataformat" title="Permalink to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="kittycad.models.unit_data_format.UnitDataFormat">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">kittycad.models.unit_data_format.</span></span><span class="sig-name descname"><span class="pre">UnitDataFormat</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">value</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">names</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</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">module</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">qualname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">type</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">start</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">boundary</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/unit_data_format.html#UnitDataFormat"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat" title="Permalink to this definition"></a></dt>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">enum.Enum</span></code></a></p>
<dd><p>Bases: <a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a>, <a class="reference external" href="https://docs.python.org/3/library/enum.html#enum.Enum" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></a></p>
<p>The valid types of data unit formats.</p>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.unit_data_format.UnitDataFormat.__init__">
@ -260,10 +270,6 @@
<p class="rubric">Methods</p>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#id0" title="kittycad.models.unit_data_format.UnitDataFormat.__init__"><code class="xref py py-obj docutils literal notranslate"><span class="pre">__init__</span></code></a>(*args, **kwds)</p></td>
<td><p></p></td>
@ -413,10 +419,6 @@
</table>
<p class="rubric">Attributes</p>
<table class="autosummary longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#kittycad.models.unit_data_format.UnitDataFormat.BYTE" title="kittycad.models.unit_data_format.UnitDataFormat.BYTE"><code class="xref py py-obj docutils literal notranslate"><span class="pre">BYTE</span></code></a></p></td>
<td><p>//en.wikipedia.org/wiki/Byte#Multiple-byte_units&gt;</p></td>
@ -437,7 +439,7 @@
<span class="sig-name descname"><span class="pre">BIT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'bit'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.BIT" title="Permalink to this definition"></a></dt>
<dd><p>//en.wikipedia.org/wiki/Exabit&gt;</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p># &lt;https</p>
</dd>
</dl>
@ -448,7 +450,7 @@
<span class="sig-name descname"><span class="pre">BYTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'byte'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.BYTE" title="Permalink to this definition"></a></dt>
<dd><p>//en.wikipedia.org/wiki/Byte#Multiple-byte_units&gt;</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p># &lt;https</p>
</dd>
</dl>
@ -464,7 +466,7 @@
<span class="sig-name descname"><span class="pre">EXABYTE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'exabyte'</span></em><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.EXABYTE" title="Permalink to this definition"></a></dt>
<dd><p>//en.wikipedia.org/wiki/Bit&gt;</p>
<dl class="field-list simple">
<dt class="field-odd">Type</dt>
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p># &lt;https</p>
</dd>
</dl>
@ -637,7 +639,7 @@
<span class="sig-name descname"><span class="pre">__str__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="reference internal" href="../_modules/kittycad/models/unit_data_format.html#UnitDataFormat.__str__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.__str__" title="Permalink to this definition"></a></dt>
<dd><p>Return str(self).</p>
<dl class="field-list simple">
<dt class="field-odd">Return type</dt>
<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/stdtypes.html#str" title="(in Python v3.11)"><code class="xref py py-class docutils literal notranslate"><span class="pre">str</span></code></a></p>
</dd>
</dl>
@ -957,7 +959,7 @@ string.</p>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.unit_data_format.UnitDataFormat.replace">
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.replace" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">old</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">new</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">count</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">/</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.replace" title="Permalink to this definition"></a></dt>
<dd><p>Return a copy with all occurrences of substring old replaced by new.</p>
<blockquote>
<div><dl class="simple">
@ -1008,7 +1010,7 @@ and the original string.</p>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.unit_data_format.UnitDataFormat.rsplit">
<span class="sig-name descname"><span class="pre">rsplit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxsplit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.rsplit" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">rsplit</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxsplit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.rsplit" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of the substrings in the string, using sep as the separator string.</p>
<blockquote>
<div><dl>
@ -1034,7 +1036,7 @@ empty strings from the result.</p>
<dl class="py method">
<dt class="sig sig-object py" id="kittycad.models.unit_data_format.UnitDataFormat.split">
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxsplit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-</span> <span class="pre">1</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.split" title="Permalink to this definition"></a></dt>
<span class="sig-name descname"><span class="pre">split</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sep</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">maxsplit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">-1</span></span></em><span class="sig-paren">)</span><a class="reference external" href="https://github.com/kittycad/kittycad.py/kittycad/models/unit_data_format.py"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#kittycad.models.unit_data_format.UnitDataFormat.split" title="Permalink to this definition"></a></dt>
<dd><p>Return a list of the substrings in the string, using sep as the separator string.</p>
<blockquote>
<div><dl>