Merge 0889ccb into release

CHANGELOG.md

@@ -8,14 +8,19 @@ The changelog format is based on [Keep a Changelog](https://keepachangelog.com/e
 -/-
 
 
-## [0.4.0] - 2024-10-21
+## [0.4.0] - 2024-11-11
 
 ### Breaking changes
 * Renamed modules: Following modules have been renamed in order to comply with PEP8 naming conventions: <br>
   `dictIO.dictReader` **->** `dictIO.dict_reader` <br>
   `dictIO.dictWriter` **->** `dictIO.dict_writer` <br>
   `dictIO.dictParser` **->** `dictIO.dict_parser` <br>
   `dictIO.cppDict` **->** `dictIO.cpp_dict` <br>
+* Module `formatter.py` : <br>
+  Renamed `Formatter.format_type()` **->** `Formatter.format_value()` <br>
+* Module `parser.py` : <br>
+  Renamed `Parser.parse_type()` **->** `Parser.parse_value()` <br>
+  Renamed `Parser.parse_types()` **->** `Parser.parse_values()` <br>
 * class `CppDict` in module `dictIO.cppDict` has been replaced with the new class `SDict[K, V]` in module `dictIO.dict`. <br>
   In order to maintain backward compatibility, a thin wrapper class named `CppDict` is kept in version ~0.4.0.
   It is marked as deprecated, though, and will be removed with release 0.5.0.

docs/source/api.rst

@@ -1,17 +1,7 @@
 API Reference
 =============
 
-.. autosummary::
-   :toctree: _autosummary
-   :template: custom-module.rst
-   :recursive:
+.. toctree::
+   :maxdepth: 4
 
-   dictIO.dict
-   dictIO.dict_parser
-   dictIO.dict_reader
-   dictIO.dict_writer
-   dictIO.formatter
-   dictIO.parser
-   dictIO.types
-   dictIO.utils
-   dictIO.cpp_dict
+   dictIO

docs/source/conf.py

@@ -26,7 +26,7 @@
 author = "Frank Lumpitzsch, Claas Rostock, Seung Hyeon Yoo"
 
 # The full version, including alpha/beta/rc tags
-release = "0.4.0b10"
+release = "0.4.0"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

docs/source/dictIO.rst

@@ -0,0 +1,30 @@
+dictIO package
+==============
+
+Subpackages
+-----------
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module.rst
+   :recursive:
+
+   dictIO.utils
+
+
+Modules
+-------
+
+.. autosummary::
+   :toctree: _autosummary
+   :template: custom-module.rst
+   :recursive:
+
+   dictIO.dict
+   dictIO.dict_parser
+   dictIO.dict_reader
+   dictIO.dict_writer
+   dictIO.formatter
+   dictIO.parser
+   dictIO.types
+   dictIO.cpp_dict

pyproject.toml

@@ -22,7 +22,7 @@ packages = [
 
 [project]
 name = "dictIO"
-version = "0.4.0b10"
+version = "0.4.0"
 description = "Python package to read, write and manipulate dictionary text files. Supports dictIOs native file format, as well as JSON, XML and OpenFOAM."
 readme = "README.md"
 requires-python = ">= 3.10"