Added changelog

Added changelog to document changes to crema for subsequent changes/releases.
Noble-Lab · Jun 11, 2021 · 89b1dc3 · 89b1dc3
1 parent c49306a
commit 89b1dc3
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 4 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -0,0 +1,10 @@
+# Changelog for crema  
+
+## [0.0.5] - 2021-06-11  
+### Added  
+- This changelog.
+
+### Changed  
+- Refactored the structure of classes and functions for better organization and readability
+- Updated and improved unit/system tests
+- Huge speed increase in calculating confidence level estimates
diff --git a/docs/api/confidence.rst b/docs/api/confidence.rst
@@ -1,5 +1,5 @@
 Confidence
-=========
+===========
 
 .. automodule:: crema.confidence
     :members: TdcConfidence
diff --git a/docs/changelog.rst b/docs/changelog.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -47,6 +47,7 @@
     "sphinx.ext.intersphinx",
     "sphinxarg.ext",
     "nbsphinx",
+    "myst_parser",
 ]
 
 nbsphinx_execute = "never"

diff --git a/docs/index.rst b/docs/index.rst
@@ -12,7 +12,7 @@
    self
    cli.rst
    api/index.rst
-   Changelog <changelog.rst>
+   Changelog <CHANGELOG.md>
 
 
 Getting Started