Skip to content

Commit

Permalink
Regenerate documentation for 0.4.0.
Browse files Browse the repository at this point in the history
  • Loading branch information
HugoFara committed Jun 21, 2023
1 parent f7a939f commit 4e57f96
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 28 deletions.
Binary file modified docs/doctrees/changeloglink.doctree
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
Binary file not shown.
48 changes: 24 additions & 24 deletions docs/html/changeloglink.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,15 +46,15 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="readmelink.html">Readme</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#unreleased">[Unreleased]</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#added">Added</a></li>
<li class="toctree-l3"><a class="reference internal" href="#changed">Changed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#fixed">Fixed</a></li>
<li class="toctree-l3"><a class="reference internal" href="#deprecated">Deprecated</a></li>
<li class="toctree-l3"><a class="reference internal" href="#removed">Removed</a></li>
<li class="toctree-l2"><a class="reference internal" href="#id1">[0.4.0] - 2023-06-21</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#added-in-0-4-0">Added in 0.4.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#changed-in-0-4-0">Changed in 0.4.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#fixed-in-0-4-0">Fixed in 0.4.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#deprecated-in-0-4-0">Deprecated in 0.4.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="#removed-in-0-4-0">Removed in 0.4.0</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id1">[0.3.1] - 2023-06-14</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id2">[0.3.1] - 2023-06-14</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#added-in-0-3-1">Added in 0.3.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#changed-in-0-3-1">Changed in 0.3.1</a></li>
<li class="toctree-l3"><a class="reference internal" href="#fixed-in-0-3-1">Fixed in 0.3.1</a></li>
Expand Down Expand Up @@ -114,7 +114,7 @@
<li class="toctree-l3"><a class="reference internal" href="#fixed-in-0-0-2">Fixed in 0.0.2</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#id2">[0.0.1-alpha] - 2021-06-22</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id3">[0.0.1-alpha] - 2021-06-22</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#added-in-0-0-1">Added in 0.0.1</a></li>
</ul>
</li>
Expand Down Expand Up @@ -169,10 +169,10 @@ <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this he
<p>All notable changes to the LeggedSnake will be documented in this file.</p>
<p>The format is based on <a class="reference external" href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>,
and this project adheres to <a class="reference external" href="https://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
<section id="unreleased">
<h2>[Unreleased]<a class="headerlink" href="#unreleased" title="Permalink to this heading"></a></h2>
<section id="added">
<h3>Added<a class="headerlink" href="#added" title="Permalink to this heading"></a></h3>
<section id="id1">
<h2>[0.4.0] - 2023-06-21<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<section id="added-in-0-4-0">
<h3>Added in 0.4.0<a class="headerlink" href="#added-in-0-4-0" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>View all walkers!</p>
<ul>
Expand All @@ -192,8 +192,8 @@ <h3>Added<a class="headerlink" href="#added" title="Permalink to this heading">
<li><p>In <code class="docutils literal notranslate"><span class="pre">docs/examples/strider.py</span></code> we recommend to use <code class="docutils literal notranslate"><span class="pre">total_distance</span></code> as the fitness function.</p></li>
</ul>
</section>
<section id="changed">
<h3>Changed<a class="headerlink" href="#changed" title="Permalink to this heading"></a></h3>
<section id="changed-in-0-4-0">
<h3>Changed in 0.4.0<a class="headerlink" href="#changed-in-0-4-0" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Genetic optimization:</p>
<ul>
Expand All @@ -217,23 +217,23 @@ <h3>Changed<a class="headerlink" href="#changed" title="Permalink to this headin
<li><p>In <code class="docutils literal notranslate"><span class="pre">docs/example/strider.py</span></code>, simulation time was increased from 30 seconds to 40. It was just not enough.</p></li>
</ul>
</section>
<section id="fixed">
<h3>Fixed<a class="headerlink" href="#fixed" title="Permalink to this heading"></a></h3>
<section id="fixed-in-0-4-0">
<h3>Fixed in 0.4.0<a class="headerlink" href="#fixed-in-0-4-0" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Documentation of <code class="docutils literal notranslate"><span class="pre">evolutionary_optimization_builtin</span></code> was wrong: returned data were in order (fitness, dimensions, position),
but (fitness, position, dimensions) was indicated.</p></li>
<li><p>After a genetic optimization, the example script was assigning wrong data to the demo walker.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">kwargs_switcher</span></code> from <code class="docutils literal notranslate"><span class="pre">geneticoptimizer.py</span></code> do no longer pop (destroy) argument from the input dictionary.</p></li>
</ul>
</section>
<section id="deprecated">
<h3>Deprecated<a class="headerlink" href="#deprecated" title="Permalink to this heading"></a></h3>
<section id="deprecated-in-0-4-0">
<h3>Deprecated in 0.4.0<a class="headerlink" href="#deprecated-in-0-4-0" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">setup.cfg</span></code> should no longer be used, as it is replaced by <code class="docutils literal notranslate"><span class="pre">pyproject.toml</span></code>.</p></li>
</ul>
</section>
<section id="removed">
<h3>Removed<a class="headerlink" href="#removed" title="Permalink to this heading"></a></h3>
<section id="removed-in-0-4-0">
<h3>Removed in 0.4.0<a class="headerlink" href="#removed-in-0-4-0" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">evolutionary_optimization</span></code> function is removed. Use <code class="docutils literal notranslate"><span class="pre">GeneticOptimization</span></code> class instead.</p>
<ul>
Expand All @@ -248,8 +248,8 @@ <h3>Removed<a class="headerlink" href="#removed" title="Permalink to this headin
</ul>
</section>
</section>
<section id="id1">
<h2>[0.3.1] - 2023-06-14<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<section id="id2">
<h2>[0.3.1] - 2023-06-14<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h2>
<p>Starting from 0.3.1, we won’t include “-alpha” or “-beta” in the naming scheme,
as it is considered irrelevant.</p>
<section id="added-in-0-3-1">
Expand Down Expand Up @@ -535,8 +535,8 @@ <h3>Fixed in 0.0.2<a class="headerlink" href="#fixed-in-0-0-2" title="Permalink
</ul>
</section>
</section>
<section id="id2">
<h2>[0.0.1-alpha] - 2021-06-22<a class="headerlink" href="#id2" title="Permalink to this heading"></a></h2>
<section id="id3">
<h2>[0.0.1-alpha] - 2021-06-22<a class="headerlink" href="#id3" title="Permalink to this heading"></a></h2>
<p>Basic version, supporting Genetic Algorithm optimization, but with various
problems.</p>
<section id="added-in-0-0-1">
Expand Down
6 changes: 3 additions & 3 deletions docs/html/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -106,8 +106,8 @@ <h1>Welcome to LeggedSnake’s documentation!<a class="headerlink" href="#welcom
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changeloglink.html">Changelog</a><ul>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#unreleased">[Unreleased]</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#id1">[0.3.1] - 2023-06-14</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#id1">[0.4.0] - 2023-06-21</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#id2">[0.3.1] - 2023-06-14</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#beta-2021-07-21">[0.3.0-beta] - 2021-07-21</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#alpha-2021-07-14">[0.2.0-alpha] - 2021-07-14</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#alpha-2021-07-12">[0.1.4-alpha] - 2021-07-12</a></li>
Expand All @@ -117,7 +117,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#id2">[0.0.1-alpha] - 2021-06-22</a></li>
<li class="toctree-l2"><a class="reference internal" href="changeloglink.html#id3">[0.0.1-alpha] - 2021-06-22</a></li>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Large diffs are not rendered by default.

0 comments on commit 4e57f96

Please sign in to comment.