Mod: Update version to 0.5.1 and sphinx documentation pages.

Labbeti · Dec 20, 2023 · 4387f23 · 4387f23
1 parent 48ac50c
commit 4387f23
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,10 @@
 
 All notable changes to this project will be documented in this file.
 
-## [0.5.1] UNRELEASED
+## [0.5.1] 2023-12-20
+### Added
+- Check sentences inputs for all metrics.
+
 ### Fixed
 - Fix `BERTScoreMRefs` metric with 1 candidate and 1 reference.
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -19,5 +19,5 @@ keywords:
   - captioning
   - audio-captioning
 license: MIT
-version: 0.5.0
-date-released: '2023-12-08'
+version: 0.5.1
+date-released: '2023-12-20'
diff --git a/README.md b/README.md
@@ -239,7 +239,7 @@ If you use this software, please consider cite it as "Labbe, E. (2013). aac-metr
     month = {12},
     title = {{aac-metrics}},
     url = {https://github.com/Labbeti/aac-metrics/},
-    version = {0.5.0},
+    version = {0.5.1},
     year = {2023},
 }
 ```

diff --git a/docs/aac_metrics.utils.globals.rst b/docs/aac_metrics.utils.globals.rst
@@ -0,0 +1,7 @@
+aac\_metrics.utils.globals module
+=================================
+
+.. automodule:: aac_metrics.utils.globals
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/aac_metrics.utils.paths.rst b/docs/aac_metrics.utils.paths.rst
diff --git a/src/aac_metrics/__init__.py b/src/aac_metrics/__init__.py
@@ -10,7 +10,7 @@
 __maintainer__ = "Etienne Labbé (Labbeti)"
 __name__ = "aac-metrics"
 __status__ = "Development"
-__version__ = "0.5.0"
+__version__ = "0.5.1"
 
 
 from .classes.base import AACMetric