RLS: Prepare doc and version for new release.

MilanSkocic · Jan 3, 2024 · c094c24 · c094c24
1 parent 399fc51
commit c094c24
Show file tree

Hide file tree

Showing 6 changed files with 40 additions and 14 deletions.
diff --git a/documentation/sphinx/source/api/iapws.rst b/documentation/sphinx/source/api/iapws.rst
@@ -12,7 +12,7 @@ Fortran
 
     * `iapws.f90`: Main module for the whole library.
 
-    .. literalinclude:: ../../../../src/iapws_g704.f90
+    .. literalinclude:: ../../../../src/iapws.f90
         :language: Fortran
 
     IAPWS R283: Critical Constants
@@ -23,23 +23,13 @@ Fortran
     .. literalinclude:: ../../../../src/iapws_r283.f90
         :language: Fortran
 
-    * `iapws_r283_capi.f90`: C API for IAPWS R2-83.
-
-    .. literalinclude:: ../../../../src/iapws_r283_capi.f90
-        :language: Fortran
-
     IAPWS G704: Gas solubilities
     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
     * `iapws_g704.f90`: Module for IAPWS G7-04
 
     .. literalinclude:: ../../../../src/iapws_g704.f90
         :language: Fortran
-
-    * `iapws_g704_capi.f90`: C API for IAPWS G7-04.
-
-    .. literalinclude:: ../../../../src/iapws_g704_capi.f90
-        :language: Fortran
 
 C
 ------

diff --git a/documentation/sphinx/source/conf.py b/documentation/sphinx/source/conf.py
@@ -42,7 +42,7 @@
 # built documents.
 #
 # The short X.Y version.
-version = "0.2.2" 
+version = "0.3.0" 
 # The full version, including alpha/beta/rc tags.
 release = version
 

diff --git a/documentation/sphinx/source/releases/0.3.0-notes.rst b/documentation/sphinx/source/releases/0.3.0-notes.rst
@@ -0,0 +1,35 @@
+iapws 0.3.0 Release Note
+==================================
+
+Summary
+--------
+
+* API break: functions for the Fortran code were renamed: 
+   * They do not contain the package+module in the name for the sake of simplicity 
+   * The package is only added in the functions for the C API in order to have a namespace-like behavior.
+   * If needed for solving conflicts with other packages, the functions can be aliased.
+* Remove separate sources files for the C API code for each module.
+  Each module now contains the code for the C API.
+* Implement tests with the test-drive framework.
+* Add version extension in the pywrapper.
+* Implement version module with its getter.
+* Documentation update.
+
+Download
+----------
+
+`iapws <https://github.com/MilanSkocic/iapws/releases>`_
+
+`pyiapws <https://pypi.org/project/pyiapws>`_
+
+
+Contributors
+---------------
+
+Milan Skocic
+
+
+Commits
+--------
+
+Full Changelog: https://github.com/MilanSkocic/iapws/compare/0.2.2...0.3.0
diff --git a/documentation/sphinx/source/releases/index.rst b/documentation/sphinx/source/releases/index.rst
@@ -4,6 +4,7 @@ Release Notes
 .. toctree::
     :maxdepth: 1
 
+    0.3.0-notes.rst
     0.2.2-notes.rst
     0.2.1-notes.rst
     0.2.0-notes.rst

diff --git a/fpm.toml b/fpm.toml
@@ -1,5 +1,5 @@
 name = "iapws"
-version = "0.2.2" # version must be also updated in: sources, pyproject.toml and sphinx conf.py
+version = "0.3.0" # version must be also updated in: sources, pyproject.toml and sphinx conf.py
 license = "GNU General Public License v3 (GPLv3)"
 author = "Milan Skocic"
 maintainer = "milan.skocic@icloud.com"

diff --git a/pywrapper/pyproject.toml b/pywrapper/pyproject.toml
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyiapws"
-version = "0.2.2"
+version = "0.3.0"
 authors = [{name = "Milan Skocic", email = "milan.skocic@icloud.com"}]
 description = "pyiapws: IAPWS for python."
 readme = "README.rst"