Skip to content

Commit

Permalink
Update the changelog titles.
Browse files Browse the repository at this point in the history
  • Loading branch information
@HugoFara
HugoFara committed Jun 14, 2023
1 parent e046ab4 commit 35d372c
Show file tree
Hide file tree
Showing 6 changed files with 27 additions and 22 deletions.
11 changes: 7 additions & 4 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,22 @@ All notable changes to the LeggedSnake will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [0.3.1] - 2023-06-14

### Added
Starting from 0.3.1, we won't include "-alpha" or "-beta" in the naming scheme,
as it is considered irrelevant.

### Added in 0.3.1

- ``requirements-dev.txt`` that contain dev requirements. It makes contribution easier.
- PyCharm configuration files.

### Changed
### Changed in 0.3.1

- Animations are now all stored in local variables, and no longer in an "ani"
global list of animations.

### Fixed
### Fixed in 0.3.1

- The main example file ``strider.py`` was launching animations for each subprocess.
This file is now considered an executable.
Expand Down
Binary file modified docs/doctrees/changeloglink.doctree
View file
Binary file not shown.
Binary file modified docs/doctrees/environment.pickle
View file
Binary file not shown.
32 changes: 17 additions & 15 deletions docs/html/changeloglink.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@
<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-l2"><a class="reference internal" href="#id1">[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>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#beta-2021-07-21">[0.3.0-beta] - 2021-07-21</a><ul>
Expand Down Expand Up @@ -106,7 +106,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="#id1">[0.0.1-alpha] - 2021-06-22</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#id2">[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 @@ -161,24 +161,26 @@ <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.3.1] - 2023-06-14<a class="headerlink" href="#id1" 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">
<h3>Added in 0.3.1<a class="headerlink" href="#added-in-0-3-1" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">requirements-dev.txt</span></code> that contain dev requirements. It makes contribution easier.</p></li>
<li><p>PyCharm configuration files.</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-3-1">
<h3>Changed in 0.3.1<a class="headerlink" href="#changed-in-0-3-1" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>Animations are now all stored in local variables, and no longer in an “ani”
global list of animations.</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-3-1">
<h3>Fixed in 0.3.1<a class="headerlink" href="#fixed-in-0-3-1" title="Permalink to this heading"></a></h3>
<ul class="simple">
<li><p>The main example file <code class="docutils literal notranslate"><span class="pre">strider.py</span></code> was launching animations for each subprocess.
This file is now considered an executable.</p></li>
Expand Down Expand Up @@ -446,8 +448,8 @@ <h3>Fixed in 0.0.2<a class="headerlink" href="#fixed-in-0-0-2" title="Permalink
</ul>
</section>
</section>
<section id="id1">
<h2>[0.0.1-alpha] - 2021-06-22<a class="headerlink" href="#id1" title="Permalink to this heading"></a></h2>
<section id="id2">
<h2>[0.0.1-alpha] - 2021-06-22<a class="headerlink" href="#id2" 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
4 changes: 2 additions & 2 deletions docs/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <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#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 @@ -114,7 +114,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#id1">[0.0.1-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>
</ul>
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit 35d372c

Please sign in to comment.