hot fix changelog (#60)

Co-authored-by: Kaiyu Zheng <kzheng@theaiinstitute.com>
h2r · Mar 13, 2024 · 8e867f3 · 8e867f3
1 parent dfe5d7c
commit 8e867f3
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 64 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -13,20 +13,8 @@ Version 1.3.5 (03/12/2024)
 * Improved modularity and documentation for the RockSample example
 * :py:mod:`~pomdp_py.representations.distribution.particles.WeightedParticles` now hashable if frozen.
 * Changed :code:`det_dict_hash` to not use sorting
-* Added a GHA workflow  for automatically building, releasing wheels and uploading them to PyPI
-* Repo convention: default branch renamed from :code:`master` to :code:`main`, and :code:`dev-latest` is the development branch.
-
-
-WeightedParticles now hashable if frozen
-Refactor _search in POUCT for more modularity
-added a workflow that builds wheel
-*
-
-Modernize repo without introducing new features.
-* Migrate to :code:`pyproject.toml` to specify dependencies, with minimal :code:`setup.py` to build Cython extensions.
-* Separate core and optional dependencies. Optional dependencies are needed only for `pomdp_py.problems`.
-* Added CI testing to repo.
-* Added pre-commit checks to repo.
+* Added a Github Action workflow  for automatically building, releasing wheels and uploading them to PyPI
+* Default branch renamed to :code:`main`, and :code:`dev-latest` is the development branch. Before a release, :code:`dev-<version>` should be created based off of :code:`dev-latest`.
 
 
 Version 1.3.4 (01/26/2024)

diff --git a/docs/html/_sources/changelog.rst.txt b/docs/html/_sources/changelog.rst.txt
@@ -13,20 +13,8 @@ Version 1.3.5 (03/12/2024)
 * Improved modularity and documentation for the RockSample example
 * :py:mod:`~pomdp_py.representations.distribution.particles.WeightedParticles` now hashable if frozen.
 * Changed :code:`det_dict_hash` to not use sorting
-* Added a GHA workflow  for automatically building, releasing wheels and uploading them to PyPI
-* Repo convention: default branch renamed from :code:`master` to :code:`main`, and :code:`dev-latest` is the development branch.
-
-
-WeightedParticles now hashable if frozen
-Refactor _search in POUCT for more modularity
-added a workflow that builds wheel
-*
-
-Modernize repo without introducing new features.
-* Migrate to :code:`pyproject.toml` to specify dependencies, with minimal :code:`setup.py` to build Cython extensions.
-* Separate core and optional dependencies. Optional dependencies are needed only for `pomdp_py.problems`.
-* Added CI testing to repo.
-* Added pre-commit checks to repo.
+* Added a Github Action workflow  for automatically building, releasing wheels and uploading them to PyPI
+* Default branch renamed to :code:`main`, and :code:`dev-latest` is the development branch. Before a release, :code:`dev-<version>` should be created based off of :code:`dev-latest`.
 
 
 Version 1.3.4 (01/26/2024)

diff --git a/docs/html/api/modules.html b/docs/html/api/modules.html
@@ -297,38 +297,40 @@ <h1>pomdp_py<a class="headerlink" href="#pomdp-py" title="Link to this heading">
 </li>
 <li class="toctree-l1"><a class="reference internal" href="pomdp_py.problems.html">pomdp_py.problems package</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="pomdp_py.problems.html#subpackages">Subpackages</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.lasertag.html">pomdp_py.problems.lasertag package</a><ul>
-<li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.lasertag.html#module-pomdp_py.problems.lasertag">Module contents</a></li>
-</ul>
-</li>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.light_dark.html">pomdp_py.problems.light_dark package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.light_dark.html">pomdp_py.problems.light_dark package</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.light_dark.html#light-dark">Light-Dark</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.light_dark.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.light_dark.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.light_dark.html#pomdp-py-problems-light-dark-problem-discrete-module">pomdp_py.problems.light_dark.problem_discrete module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.light_dark.html#pomdp-py-problems-light-dark-test-module">pomdp_py.problems.light_dark.test module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.light_dark.html#module-contents">Module contents</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.load_unload.html">pomdp_py.problems.load_unload package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.load_unload.html">pomdp_py.problems.load_unload package</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.load_unload.html#load-unload">Load/Unload</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.load_unload.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.load_unload.html#module-pomdp_py.problems.load_unload.load_unload">pomdp_py.problems.load_unload.load_unload module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.load_unload.html#module-pomdp_py.problems.load_unload">Module contents</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.maze.html">pomdp_py.problems.maze package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.maze.html">pomdp_py.problems.maze package</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.maze.html#maze">Maze</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.maze.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.maze.html#module-pomdp_py.problems.maze">Module contents</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html">pomdp_py.problems.multi_object_search package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html">pomdp_py.problems.multi_object_search package</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html#multi-object-search-mos-task">Multi-Object Search (MOS) Task</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html#module-pomdp_py.problems.multi_object_search.example_worlds">pomdp_py.problems.multi_object_search.example_worlds module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html#module-pomdp_py.problems.multi_object_search.problem">pomdp_py.problems.multi_object_search.problem module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.multi_object_search.html#module-pomdp_py.problems.multi_object_search">Module contents</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.rocksample.html">pomdp_py.problems.rocksample package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.rocksample.html">pomdp_py.problems.rocksample package</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.rocksample.html#rocksample">RockSample</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.rocksample.html#pomdp-problems-rocksample-rocksample-problem-module">pomdp_problems.rocksample.rocksample_problem module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.rocksample.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.rocksample.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.rocksample.html#module-pomdp_py.problems.rocksample.cythonize">pomdp_py.problems.rocksample.cythonize module</a></li>
@@ -346,7 +348,8 @@ <h1>pomdp_py<a class="headerlink" href="#pomdp-py" title="Link to this heading">
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.tag.html#module-pomdp_py.problems.tag">Module contents</a></li>
 </ul>
 </li>
-<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.tiger.html">pomdp_py.problems.tiger package</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.tiger.html">pomdp_py.problems.tiger package</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pomdp_py.problems.tiger.html#tiger">Tiger</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.tiger.html#subpackages">Subpackages</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.tiger.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="pomdp_py.problems.tiger.html#module-pomdp_py.problems.tiger.cythonize">pomdp_py.problems.tiger.cythonize module</a></li>