From d94d890b466ae07d44d1ac174f809cdd607ce905 Mon Sep 17 00:00:00 2001 From: KX79WQ Date: Wed, 29 Apr 2020 18:16:20 +0200 Subject: [PATCH] Small updates to documentation --- CHANGES.rst | 5 +++-- README.rst | 3 ++- docs/source/tutorials.rst | 8 ++++---- 3 files changed, 9 insertions(+), 7 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 1bd01b55..f3b34f55 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -2,7 +2,8 @@ Release notes ============= -Version 0.3.1, March 2020 +Version 0.3.1, April 2020 ------------------------- -Released the first open-source version op popmon. +* Released the first open-source version op popmon. +* Please see documentation for full details: https://popmon.readthedocs.io diff --git a/README.rst b/README.rst index f344cf9a..63b58788 100644 --- a/README.rst +++ b/README.rst @@ -5,6 +5,7 @@ Population Shift Monitoring * Version: 0.3.1. Released: April 2020 * Documentation: https://popmon.readthedocs.io * Repository: https://github.com/ing-bank/popmon +* Authors: ING Wholesale Banking Advanced Analytics .. figure:: https://github.com/ing-bank/popmon/blob/master/docs/source/assets/popmon-logo.png :width: 300px @@ -124,4 +125,4 @@ Please note that ING WBAA provides support only on a best-effort basis. License ======= -`popmon` is completely free, open-source and licensed under the `MIT license `_. +Copyright ING WBAA. `popmon` is completely free, open-source and licensed under the `MIT license `_. diff --git a/docs/source/tutorials.rst b/docs/source/tutorials.rst index aa84de9b..5c080b8f 100644 --- a/docs/source/tutorials.rst +++ b/docs/source/tutorials.rst @@ -8,8 +8,8 @@ The tutorials are available in the ``popmon/notebooks`` directory. We have: * A basic tutorial: this covers generating a stability report from a DataFrame, as well as various simple configurations. * Incremental data: a tutorial showing how to stitch the histograms of incremental (batch-wise) datasets and to generate reports from those. -You can open these notebooks directly: - -* Run them interactively at `MyBinder `_. -* View them statically: `detailed example tutorial `_ and `basic tutorial `_ and `incremental datasets `_. +You can see these notebooks here: +* `detailed example `_ +* `basic tutorial `_ +* `incremental datasets `_.