Skip to content

Commit

Permalink
Regenerate documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoFara committed Jun 23, 2023
1 parent 09bd285 commit 50e9003
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 11 deletions.
1 change: 1 addition & 0 deletions docs/changeloglink.html
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ <h3>Changed in 0.5.3<a class="headerlink" href="#changed-in-0-5-3" title="Permal
<li><p>Now <code class="docutils literal notranslate"><span class="pre">docs/</span></code> only contains sphinx documentation.</p></li>
</ul>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">docs/examles/images</span></code> moved to <code class="docutils literal notranslate"><span class="pre">images/</span></code>.</p></li>
</ul>
</section>
<section id="fixed-in-0-5-3">
Expand Down
10 changes: 5 additions & 5 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ <h3>Setting up Virtual Environment<a class="headerlink" href="#setting-up-virtua
<section id="short-demo">
<h2>Short demo<a class="headerlink" href="#short-demo" title="Permalink to this heading"></a></h2>
<p>Let’s start with a short demo of the package’s capabilities.</p>
<p>It is highly Pythonning and emphasizes efficient code. Here is the definition of a <strong>four-bar linkage</strong>.</p>
<p>It is highly Pythonic and emphasizes efficient code. Here is the definition of a <strong>four-bar linkage</strong>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pylinkage</span> <span class="k">as</span> <span class="nn">pl</span>

<span class="c1"># Main motor</span>
Expand All @@ -199,7 +199,7 @@ <h2>Short demo<a class="headerlink" href="#short-demo" title="Permalink to this
<span class="n">pl</span><span class="o">.</span><span class="n">show_linkage</span><span class="p">(</span><span class="n">my_linkage</span><span class="p">)</span>
</pre></div>
</div>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<p>Cool, isn’t it? But the package doesn’t stop here as it provides a library <strong>to achieve any movement</strong>.</p>
<p>Let’s say that you want the <code class="docutils literal notranslate"><span class="pre">pin</span></code> joint to stay in top-right corner, with an amplitude of [0, 90] exactly.
You can solve it by yourself, you can ask the code to do it for you.</p>
Expand All @@ -224,7 +224,7 @@ <h2>Short demo<a class="headerlink" href="#short-demo" title="Permalink to this
<span class="n">pl</span><span class="o">.</span><span class="n">show_linkage</span><span class="p">(</span><span class="n">my_linkage</span><span class="p">)</span>
</pre></div>
</div>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<p>Tadaaa!
We defined a mechanism, solved an issue and viewed the result in a few lines of code!
And remember, you can define any objective function, so let’s give it a try!</p>
Expand Down Expand Up @@ -315,7 +315,7 @@ <h3>Visualization<a class="headerlink" href="#visualization" title="Permalink to
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pl</span><span class="o">.</span><span class="n">show_linkage</span><span class="p">(</span><span class="n">my_linkage</span><span class="p">)</span>
</pre></div>
</div>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<p>Last recap, rearranging names:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Main motor</span>
<span class="n">crank</span> <span class="o">=</span> <span class="n">pl</span><span class="o">.</span><span class="n">Crank</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">joint0</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">angle</span><span class="o">=</span><span class="mf">.31</span><span class="p">,</span> <span class="n">distance</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;B&quot;</span><span class="p">)</span>
Expand Down Expand Up @@ -421,7 +421,7 @@ <h3>Optimization<a class="headerlink" href="#optimization" title="Permalink to t
</div>
<p>Here the result can vary, but it is rarely above 0.2.</p>
<p>So we made something that says it works, let’s verify it:</p>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<p>With a bit of imagination, you have a wonderful windshield wiper!</p>
</section>
</section>
Expand Down
10 changes: 5 additions & 5 deletions docs/readmelink.html
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ <h3>Setting up Virtual Environment<a class="headerlink" href="#setting-up-virtua
<section id="short-demo">
<h2>Short demo<a class="headerlink" href="#short-demo" title="Permalink to this heading"></a></h2>
<p>Let’s start with a short demo of the package’s capabilities.</p>
<p>It is highly Pythonning and emphasizes efficient code. Here is the definition of a <strong>four-bar linkage</strong>.</p>
<p>It is highly Pythonic and emphasizes efficient code. Here is the definition of a <strong>four-bar linkage</strong>.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pylinkage</span> <span class="k">as</span> <span class="nn">pl</span>

<span class="c1"># Main motor</span>
Expand All @@ -150,7 +150,7 @@ <h2>Short demo<a class="headerlink" href="#short-demo" title="Permalink to this
<span class="n">pl</span><span class="o">.</span><span class="n">show_linkage</span><span class="p">(</span><span class="n">my_linkage</span><span class="p">)</span>
</pre></div>
</div>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<p>Cool, isn’t it? But the package doesn’t stop here as it provides a library <strong>to achieve any movement</strong>.</p>
<p>Let’s say that you want the <code class="docutils literal notranslate"><span class="pre">pin</span></code> joint to stay in top-right corner, with an amplitude of [0, 90] exactly.
You can solve it by yourself, you can ask the code to do it for you.</p>
Expand All @@ -175,7 +175,7 @@ <h2>Short demo<a class="headerlink" href="#short-demo" title="Permalink to this
<span class="n">pl</span><span class="o">.</span><span class="n">show_linkage</span><span class="p">(</span><span class="n">my_linkage</span><span class="p">)</span>
</pre></div>
</div>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<p>Tadaaa!
We defined a mechanism, solved an issue and viewed the result in a few lines of code!
And remember, you can define any objective function, so let’s give it a try!</p>
Expand Down Expand Up @@ -266,7 +266,7 @@ <h3>Visualization<a class="headerlink" href="#visualization" title="Permalink to
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="n">pl</span><span class="o">.</span><span class="n">show_linkage</span><span class="p">(</span><span class="n">my_linkage</span><span class="p">)</span>
</pre></div>
</div>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif"><img alt="A four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20My%20four-bar%20linkage.gif" /></a>
<p>Last recap, rearranging names:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># Main motor</span>
<span class="n">crank</span> <span class="o">=</span> <span class="n">pl</span><span class="o">.</span><span class="n">Crank</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="n">joint0</span><span class="o">=</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">),</span> <span class="n">angle</span><span class="o">=</span><span class="mf">.31</span><span class="p">,</span> <span class="n">distance</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s2">&quot;B&quot;</span><span class="p">)</span>
Expand Down Expand Up @@ -372,7 +372,7 @@ <h3>Optimization<a class="headerlink" href="#optimization" title="Permalink to t
</div>
<p>Here the result can vary, but it is rarely above 0.2.</p>
<p>So we made something that says it works, let’s verify it:</p>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/examples/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<a class="reference external image-reference" href="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif"><img alt="An optimized four-bar linkage animated" src="https://github.com/HugoFara/pylinkage/raw/main/images/Kinematic%20Windscreen%20wiper.gif" /></a>
<p>With a bit of imagination, you have a wonderful windshield wiper!</p>
</section>
</section>
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 50e9003

Please sign in to comment.