update docs
This commit is contained in:
Vendored
+173
-80
@@ -6,8 +6,30 @@
|
||||
<meta charset="utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>solidLib package — solidLib documentation</title>
|
||||
|
||||
<link rel="stylesheet" href="_static/css/index.f658d18f9b420779cfdf24aa0a7e2d77.css">
|
||||
|
||||
|
||||
<link rel="stylesheet"
|
||||
href="_static/vendor/fontawesome/5.13.0/css/all.min.css">
|
||||
<link rel="preload" as="font" type="font/woff2" crossorigin
|
||||
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
|
||||
<link rel="preload" as="font" type="font/woff2" crossorigin
|
||||
href="_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
|
||||
|
||||
|
||||
|
||||
<link rel="stylesheet"
|
||||
href="_static/vendor/open-sans_all/1.44.1/index.css">
|
||||
<link rel="stylesheet"
|
||||
href="_static/vendor/lato_latin-ext/1.44.1/index.css">
|
||||
|
||||
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/basic.css" type="text/css" />
|
||||
|
||||
<link rel="preload" as="script" href="_static/js/index.d3f166471bb80abb5163.js">
|
||||
|
||||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
|
||||
<script src="_static/jquery.js"></script>
|
||||
<script src="_static/underscore.js"></script>
|
||||
@@ -15,22 +37,113 @@
|
||||
<link rel="index" title="Index" href="genindex.html" />
|
||||
<link rel="search" title="Search" href="search.html" />
|
||||
<link rel="prev" title="Welcome to solidLib’s documentation!" href="index.html" />
|
||||
|
||||
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
|
||||
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<meta name="docsearch:language" content="en" />
|
||||
</head>
|
||||
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="80">
|
||||
|
||||
<nav class="navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main">
|
||||
<div class="container-xl">
|
||||
|
||||
</head><body>
|
||||
|
||||
<a class="navbar-brand" href="index.html">
|
||||
|
||||
<p class="title">solidLib</p>
|
||||
|
||||
</a>
|
||||
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-menu" aria-controls="navbar-menu" aria-expanded="false" aria-label="Toggle navigation">
|
||||
<span class="navbar-toggler-icon"></span>
|
||||
</button>
|
||||
|
||||
<div class="document">
|
||||
<div class="documentwrapper">
|
||||
<div class="bodywrapper">
|
||||
<div id="navbar-menu" class="col-lg-9 collapse navbar-collapse">
|
||||
<ul id="navbar-main-elements" class="navbar-nav mr-auto">
|
||||
|
||||
|
||||
<li class="nav-item active">
|
||||
<a class="nav-link" href="">solidLib package</a>
|
||||
</li>
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
|
||||
|
||||
<ul class="navbar-nav">
|
||||
|
||||
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
|
||||
<div class="container-xl">
|
||||
<div class="row">
|
||||
|
||||
<div class="col-12 col-md-3 bd-sidebar"><form class="bd-search d-flex align-items-center" action="search.html" method="get">
|
||||
<i class="icon fas fa-search"></i>
|
||||
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
|
||||
</form>
|
||||
<nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
|
||||
|
||||
<div class="bd-toc-item active">
|
||||
|
||||
|
||||
<ul class="nav bd-sidenav">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</ul>
|
||||
|
||||
</nav>
|
||||
</div>
|
||||
|
||||
|
||||
<div class="body" role="main">
|
||||
|
||||
|
||||
<div class="d-none d-xl-block col-xl-2 bd-toc">
|
||||
|
||||
<div class="tocsection onthispage pt-5 pb-3">
|
||||
<i class="fas fa-list"></i> On this page
|
||||
</div>
|
||||
|
||||
<nav id="bd-toc-nav">
|
||||
<ul class="nav section-nav flex-column">
|
||||
|
||||
<li class="nav-item toc-entry toc-h2">
|
||||
<a href="#submodules" class="nav-link">Submodules</a>
|
||||
</li>
|
||||
|
||||
<li class="nav-item toc-entry toc-h2">
|
||||
<a href="#module-solidLib.assortment" class="nav-link">solidLib.assortment module</a>
|
||||
</li>
|
||||
|
||||
<li class="nav-item toc-entry toc-h2">
|
||||
<a href="#module-solidLib.globals" class="nav-link">solidLib.globals module</a>
|
||||
</li>
|
||||
|
||||
<li class="nav-item toc-entry toc-h2">
|
||||
<a href="#module-solidLib.primitives" class="nav-link">solidLib.primitives module</a>
|
||||
</li>
|
||||
|
||||
<li class="nav-item toc-entry toc-h2">
|
||||
<a href="#module-solidLib" class="nav-link">Module contents</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</nav>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
<main class="col-12 col-md-9 col-xl-7 py-md-5 pl-md-5 pr-md-4 bd-content" role="main">
|
||||
|
||||
<div>
|
||||
|
||||
<div class="section" id="solidlib-package">
|
||||
<h1>solidLib package<a class="headerlink" href="#solidlib-package" title="Permalink to this headline">¶</a></h1>
|
||||
<div class="section" id="submodules">
|
||||
@@ -107,9 +220,35 @@ the triangles used for the base structure is given by their height and width</p>
|
||||
<dt id="solidLib.primitives.round_box">
|
||||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">round_box</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x_dim</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y_dim</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">z_dim</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">radius</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">32</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#round_box"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.round_box" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>creates a round box with radius r</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><p><strong>x_dim</strong> (<em>float</em>) – <p>.</p>
|
||||
</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<div class="admonition important">
|
||||
<p class="admonition-title">Important</p>
|
||||
<p>deprecated</p>
|
||||
</div>
|
||||
<img alt="_images/round_box.png" src="_images/round_box.png" />
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="solidLib.primitives.round_box_new">
|
||||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">round_box_new</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">dim</span><span class="p">:</span> <span class="n">Iterable<span class="p">[</span>float<span class="p">]</span></span></em>, <em class="sig-param"><span class="n">radius</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">32</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#round_box_new"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.round_box_new" title="Permalink to this definition">¶</a></dt>
|
||||
<dd><p>creates a cube with rounded corners</p>
|
||||
<img alt="_images/round_box.png" src="_images/round_box.png" />
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters</dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>dim</strong> – cube dimensions to base box on.</p></li>
|
||||
<li><p><strong>radius</strong> – box radius.</p></li>
|
||||
<li><p><strong>segments</strong> – circular object segments</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py function">
|
||||
<dt id="solidLib.primitives.round_flat_box">
|
||||
<code class="sig-prename descclassname">solidLib.primitives.</code><code class="sig-name descname">round_flat_box</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">x</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">y</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">z</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">r</span><span class="p">:</span> <span class="n">float</span></em>, <em class="sig-param"><span class="n">segments</span><span class="p">:</span> <span class="n">int</span> <span class="o">=</span> <span class="default_value">32</span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/solidLib/primitives.html#round_flat_box"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#solidLib.primitives.round_flat_box" title="Permalink to this definition">¶</a></dt>
|
||||
@@ -124,78 +263,32 @@ the triangles used for the base structure is given by their height and width</p>
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<div class='prev-next-bottom'>
|
||||
|
||||
<a class='left-prev' id="prev-link" href="index.html" title="previous page">Welcome to solidLib’s documentation!</a>
|
||||
|
||||
</div>
|
||||
|
||||
</main>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
|
||||
<div class="sphinxsidebarwrapper">
|
||||
<h1 class="logo"><a href="index.html">solidLib</a></h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3>Navigation</h3>
|
||||
<p class="caption"><span class="caption-text">Contents:</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current"><a class="current reference internal" href="#">solidLib package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib.assortment">solidLib.assortment module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib.globals">solidLib.globals module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib.primitives">solidLib.primitives module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-solidLib">Module contents</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="relations">
|
||||
<h3>Related Topics</h3>
|
||||
<ul>
|
||||
<li><a href="index.html">Documentation overview</a><ul>
|
||||
<li>Previous: <a href="index.html" title="previous chapter">Welcome to solidLib’s documentation!</a></li>
|
||||
</ul></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div id="searchbox" style="display: none" role="search">
|
||||
<h3 id="searchlabel">Quick search</h3>
|
||||
<div class="searchformwrapper">
|
||||
<form class="search" action="search.html" method="get">
|
||||
<input type="text" name="q" aria-labelledby="searchlabel" />
|
||||
<input type="submit" value="Go" />
|
||||
</form>
|
||||
</div>
|
||||
</div>
|
||||
<script>$('#searchbox').show(0);</script>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</div>
|
||||
<div class="clearer"></div>
|
||||
</div>
|
||||
<div class="footer">
|
||||
©2021, Patrick Nisble.
|
||||
|
||||
|
|
||||
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.4.3</a>
|
||||
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
||||
|
||||
|
|
||||
<a href="_sources/solidLib.rst.txt"
|
||||
rel="nofollow">Page source</a>
|
||||
</div>
|
||||
|
||||
|
||||
<script src="_static/js/index.d3f166471bb80abb5163.js"></script>
|
||||
|
||||
|
||||
|
||||
<footer class="footer mt-5 mt-md-0">
|
||||
<div class="container">
|
||||
<p>
|
||||
© Copyright 2021, Patrick Nisble.<br/>
|
||||
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 3.4.3.<br/>
|
||||
</p>
|
||||
</div>
|
||||
</footer>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user