From 0cc4546c6e36fc1f3c5cd8fb68cd20f05cb07011 Mon Sep 17 00:00:00 2001
From: leufen1 <l.leufen@fz-juelich.de>
Date: Mon, 21 Sep 2020 14:08:49 +0200
Subject: [PATCH] include changelog in docs
---
CHANGELOG.md | 19 ++++++++++++++++++-
docs/_source/changelog.rst | 4 ++++
docs/_source/index.rst | 1 +
mlair/__init__.py | 2 +-
4 files changed, 24 insertions(+), 2 deletions(-)
create mode 100644 docs/_source/changelog.rst
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 09725ba7..e0c57c86 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,6 +2,23 @@
All notable changes to this project will be documented in this file.
+## v0.12.0 - 2020-09-21 - Documentation and Bugfixes
+
+### general:
+- improved documentation include installation instructions and many examples from the paper, #153
+- bugfixes (see technical)
+
+### new features:
+- `MyLittleModel` is now a pure feed-forward network (before it had a CNN part), #168
+
+### technical:
+- new compile options check to ensure its execution, #154
+- bugfix for key errors in time series plot, #169
+- bugfix for not used kwargs in `DefaultDataHandler`, #170
+- `trainable` parameter is renamed by `train_model` to prevent confusion with the tf trainable parameter, #162
+- fixed HPC installation failure, #159
+
+
## v0.11.0 - 2020-08-24 - Advanced Data Handling for MLAir
### general
@@ -11,7 +28,7 @@ All notable changes to this project will be documented in this file.
### new features
- default data handler using TOAR DB refactored according to advanced data handling, #140, #141, #152
-- data sets are handled as collections, #142, and are itable in a standard way (StandardIterator) and optimised for
+- data sets are handled as collections, #142, and are iterable in a standard way (StandardIterator) and optimised for
keras (KerasIterator), #143
- automatically moving station map plot, #136
diff --git a/docs/_source/changelog.rst b/docs/_source/changelog.rst
new file mode 100644
index 00000000..2b0ff367
--- /dev/null
+++ b/docs/_source/changelog.rst
@@ -0,0 +1,4 @@
+Changelog
+=========
+
+.. include:: ../../CHANGELOG.md
\ No newline at end of file
diff --git a/docs/_source/index.rst b/docs/_source/index.rst
index a6064304..5777cf16 100644
--- a/docs/_source/index.rst
+++ b/docs/_source/index.rst
@@ -13,6 +13,7 @@ Welcome to MLAir's documentation!
get-started
customise
+ changelog
Indices and tables
diff --git a/mlair/__init__.py b/mlair/__init__.py
index 9886cd10..0cfc33bb 100644
--- a/mlair/__init__.py
+++ b/mlair/__init__.py
@@ -1,6 +1,6 @@
__version_info__ = {
'major': 0,
- 'minor': 11,
+ 'minor': 12,
'micro': 0,
}
--
GitLab