Skip to content

Commit

Permalink
Documentation regenerated for multiprocessing.
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoFara committed Jul 21, 2021
1 parent 51cf249 commit 03f484d
Show file tree
Hide file tree
Showing 7 changed files with 290 additions and 161 deletions.
161 changes: 118 additions & 43 deletions docs/api/geneticoptimizer.html

Large diffs are not rendered by default.

257 changes: 151 additions & 106 deletions docs/changeloglink.html

Large diffs are not rendered by default.

17 changes: 13 additions & 4 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,7 @@ <h1 id="index">Index</h1>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#J"><strong>J</strong></a>
| <a href="#K"><strong>K</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
Expand Down Expand Up @@ -306,15 +307,15 @@ <h2 id="D">D</h2>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evaluate_population">evaluate_population() (in module leggedsnake.geneticoptimizer)</a>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evaluate_individual">evaluate_individual() (in module leggedsnake.geneticoptimizer)</a>
</li>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evolutionary_optimization">evolutionary_optimization() (in module leggedsnake.geneticoptimizer)</a>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evaluate_population">evaluate_population() (in module leggedsnake.geneticoptimizer)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evolutionary_optimization_builtin">evolutionary_optimization_builtin() (in module leggedsnake.geneticoptimizer)</a>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evolutionary_optimization">evolutionary_optimization() (in module leggedsnake.geneticoptimizer)</a>
</li>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evolutionnary_optimization">evolutionnary_optimization() (in module leggedsnake.geneticoptimizer)</a>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.evolutionary_optimization_builtin">evolutionary_optimization_builtin() (in module leggedsnake.geneticoptimizer)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -367,6 +368,14 @@ <h2 id="J">J</h2>
</ul></td>
</tr></table>

<h2 id="K">K</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api/geneticoptimizer.html#leggedsnake.geneticoptimizer.kwargs_switcher">kwargs_switcher() (in module leggedsnake.geneticoptimizer)</a>
</li>
</ul></td>
</tr></table>

<h2 id="L">L</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
Expand Down
8 changes: 4 additions & 4 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -190,7 +190,7 @@ <h1>Welcome to LeggedSnake’s documentation!<a class="headerlink" href="#welcom
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#alpha-2021-06-25">[0.1.0-alpha] - 2021-06-25</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#alpha-2021-06-23">[0.0.3-alpha] - 2021-06-23</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#alpha-2021-06-22">[0.0.2-alpha] - 2021-06-22</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#id19">[0.0.1-alpha] - 2021-06-22</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#id21">[0.0.1-alpha] - 2021-06-22</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -235,8 +235,8 @@ <h1>Welcome to LeggedSnake’s documentation!<a class="headerlink" href="#welcom
</ul>
</div>
<a class="reference external image-reference" href="https://pypi.python.org/pypi/leggedsnake/"><img alt="PyPI version fury.io" src="https://badge.fury.io/py/leggedsnake.svg" /></a>
<a class="reference external image-reference" href="https://pepy.tech/project/leggedsnake"><img alt="Downloads" src="https://static.pepy.tech/personalized-badge/leggedsnake?period=week&amp;units=international_system&amp;left_color=grey&amp;right_color=orange&amp;left_text=Downloads/week" /></a>
<a class="reference external image-reference" href="https://raw.githubusercontent.com/HugoFara/leggedsnake/main/LICENSE.rst"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
<a class="reference external image-reference" href="https://pepy.tech/project/leggedsnake"><img alt="Downloads" src="https://static.pepy.tech/personalized-badge/leggedsnake?period=total&amp;units=international_system&amp;left_color=grey&amp;right_color=green&amp;left_text=Downloads/week" /></a>
<a class="reference external image-reference" href="https://raw.githubusercontent.com/HugoFara/leggedsnake/master/LICENSE.rst"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
</div>
<div class="section" id="leggedsnake">
<h1>leggedsnake<a class="headerlink" href="#leggedsnake" title="Permalink to this headline"></a></h1>
Expand Down Expand Up @@ -278,7 +278,7 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<p>The demo script is <a class="reference external" href="https://github.com/HugoFara/leggedsnake/blob/main/docs/examples/strider.py">strider.py</a>, which demonstrates all the techniques about the <a class="reference external" href="https://www.diywalkers.com/strider-linkage-plans.html">Strider linkage</a>.</p>
<p>The demo script is <a class="reference external" href="https://github.com/HugoFara/leggedsnake/blob/master/docs/examples/strider.py">strider.py</a>, which demonstrates all the techniques about the <a class="reference external" href="https://www.diywalkers.com/strider-linkage-plans.html">Strider linkage</a>.</p>
<div class="section" id="defining-a-walker">
<h3>Defining a <code class="docutils literal notranslate"><span class="pre">Walker</span></code><a class="headerlink" href="#defining-a-walker" title="Permalink to this headline"></a></h3>
<p>First, you need to define joints for your <code class="docutils literal notranslate"><span class="pre">Walker</span></code> as described in <a class="reference external" href="https://github.com/HugoFara/pylinkage">pylinkage</a> documentation. Once your joints (let’s say they are in a joint object), you should have something like that:</p>
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/readmelink.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,8 @@
<div itemprop="articleBody">

<a class="reference external image-reference" href="https://pypi.python.org/pypi/leggedsnake/"><img alt="PyPI version fury.io" src="https://badge.fury.io/py/leggedsnake.svg" /></a>
<a class="reference external image-reference" href="https://pepy.tech/project/leggedsnake"><img alt="Downloads" src="https://static.pepy.tech/personalized-badge/leggedsnake?period=week&amp;units=international_system&amp;left_color=grey&amp;right_color=orange&amp;left_text=Downloads/week" /></a>
<a class="reference external image-reference" href="https://raw.githubusercontent.com/HugoFara/leggedsnake/main/LICENSE.rst"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
<a class="reference external image-reference" href="https://pepy.tech/project/leggedsnake"><img alt="Downloads" src="https://static.pepy.tech/personalized-badge/leggedsnake?period=total&amp;units=international_system&amp;left_color=grey&amp;right_color=green&amp;left_text=Downloads/week" /></a>
<a class="reference external image-reference" href="https://raw.githubusercontent.com/HugoFara/leggedsnake/master/LICENSE.rst"><img alt="License: MIT" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
<div class="section" id="leggedsnake">
<h1>leggedsnake<a class="headerlink" href="#leggedsnake" title="Permalink to this headline"></a></h1>
<p>LeggedSnake is a project intended to make the simulation of walking linkages fast and easy. We believe that building walking linkages is fun and could be useful. Our philosophy is to provide a quick way of building, optimizing and testing walking linkages.</p>
Expand Down Expand Up @@ -228,7 +228,7 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
</div>
<div class="section" id="usage">
<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline"></a></h2>
<p>The demo script is <a class="reference external" href="https://github.com/HugoFara/leggedsnake/blob/main/docs/examples/strider.py">strider.py</a>, which demonstrates all the techniques about the <a class="reference external" href="https://www.diywalkers.com/strider-linkage-plans.html">Strider linkage</a>.</p>
<p>The demo script is <a class="reference external" href="https://github.com/HugoFara/leggedsnake/blob/master/docs/examples/strider.py">strider.py</a>, which demonstrates all the techniques about the <a class="reference external" href="https://www.diywalkers.com/strider-linkage-plans.html">Strider linkage</a>.</p>
<div class="section" id="defining-a-walker">
<h3>Defining a <code class="docutils literal notranslate"><span class="pre">Walker</span></code><a class="headerlink" href="#defining-a-walker" title="Permalink to this headline"></a></h3>
<p>First, you need to define joints for your <code class="docutils literal notranslate"><span class="pre">Walker</span></code> as described in <a class="reference external" href="https://github.com/HugoFara/pylinkage">pylinkage</a> documentation. Once your joints (let’s say they are in a joint object), you should have something like that:</p>
Expand Down
Loading

0 comments on commit 03f484d

Please sign in to comment.