Add Jupyter notebook examples

barseghyanartur · Dec 25, 2019 · b4f8425 · b4f8425
1 parent 14ea5ed
commit b4f8425
Show file tree

Hide file tree

Showing 3 changed files with 59 additions and 13 deletions.
diff --git a/README.rst b/README.rst
@@ -186,6 +186,8 @@ See the
 `output <https://github.com/barseghyanartur/matyan/tree/master/src/matyan/tests/output>`_
 directory for examples.
 
+Additionally see the `Jupyter notebook examples <https://github.com/barseghyanartur/matyan/blob/master/matyan.ipynb>`_.
+
 Configuration
 =============
 In order to customize names and texts, add a ``.matyan.ini`` in your

diff --git a/docs/index.rst b/docs/index.rst
@@ -186,6 +186,8 @@ See the
 `output <https://github.com/barseghyanartur/matyan/tree/master/src/matyan/tests/output>`_
 directory for examples.
 
+Additionally see the `Jupyter notebook examples <https://github.com/barseghyanartur/matyan/blob/master/matyan.ipynb>`_.
+
 Configuration
 =============
 In order to customize names and texts, add a ``.matyan.ini`` in your

diff --git a/matyan.ipynb b/matyan.ipynb
@@ -2,13 +2,11 @@
  "cells": [
   {
    "cell_type": "markdown",
+   "metadata": {},
    "source": [
     "The following would produce output equivalent to the output of \n",
     "the ``generate-changelog --show-releases`` command."
-   ],
-   "metadata": {
-    "collapsed": false
-   }
+   ]
   },
   {
    "cell_type": "code",
@@ -23,8 +21,52 @@
    "outputs": [
     {
      "data": {
-      "text/plain": "<IPython.core.display.Markdown object>",
-      "text/markdown": "\n### 0.2\n\n#### Feature\n\n##### MSFT-1238 Token authentication\n\n- Update authentication docs. [Artur Barseghyan]\n- Implement token authentication. [Artur Barseghyan]\n\n##### MSFT-1237 Improve document sharing\n\n- Improve document sharing. Add option to share via GDrive. [Artur Barseghyan]\n\n### 0.1\n\n#### Bugfix\n\n##### MSFT-1236 Prevent duplicate postal codes\n\n- Make postal code field unique for the country. [Artur Barseghyan]\n- Normalise postal codes for US addresses. [Artur Barseghyan]\n- Normalise postal codes for German addresses. [Artur Barseghyan]\n\n#### Deprecation\n\n##### MSFT-1235 Deprecate old api\n\n- Update docs. [Artur Barseghyan]\n- Deprecate API v 2. 0. [Artur Barseghyan]\n\n#### Feature\n\n##### MSFT-1234 Car type suggester\n\n- Add insurance amount indication based on car weight. [Artur Barseghyan]\n- Initial car type suggester implementation. [Artur Barseghyan]\n\n#### Other\n\n- Readme. [Artur Barseghyan]\n"
+      "text/markdown": [
+       "\n",
+       "### 0.2\n",
+       "\n",
+       "#### Feature\n",
+       "\n",
+       "##### MSFT-1238 Token authentication\n",
+       "\n",
+       "- Update authentication docs. [Artur Barseghyan]\n",
+       "- Implement token authentication. [Artur Barseghyan]\n",
+       "\n",
+       "##### MSFT-1237 Improve document sharing\n",
+       "\n",
+       "- Improve document sharing. Add option to share via GDrive. [Artur Barseghyan]\n",
+       "\n",
+       "### 0.1\n",
+       "\n",
+       "#### Bugfix\n",
+       "\n",
+       "##### MSFT-1236 Prevent duplicate postal codes\n",
+       "\n",
+       "- Make postal code field unique for the country. [Artur Barseghyan]\n",
+       "- Normalise postal codes for US addresses. [Artur Barseghyan]\n",
+       "- Normalise postal codes for German addresses. [Artur Barseghyan]\n",
+       "\n",
+       "#### Deprecation\n",
+       "\n",
+       "##### MSFT-1235 Deprecate old api\n",
+       "\n",
+       "- Update docs. [Artur Barseghyan]\n",
+       "- Deprecate API v 2. 0. [Artur Barseghyan]\n",
+       "\n",
+       "#### Feature\n",
+       "\n",
+       "##### MSFT-1234 Car type suggester\n",
+       "\n",
+       "- Add insurance amount indication based on car weight. [Artur Barseghyan]\n",
+       "- Initial car type suggester implementation. [Artur Barseghyan]\n",
+       "\n",
+       "#### Other\n",
+       "\n",
+       "- Readme. [Artur Barseghyan]\n"
+      ],
+      "text/plain": [
+       "<IPython.core.display.Markdown object>"
+      ]
      },
      "metadata": {},
      "output_type": "display_data"
@@ -54,25 +96,25 @@
   "language_info": {
    "codemirror_mode": {
     "name": "ipython",
-    "version": 2
+    "version": 3
    },
    "file_extension": ".py",
    "mimetype": "text/x-python",
    "name": "python",
    "nbconvert_exporter": "python",
-   "pygments_lexer": "ipython2",
-   "version": "2.7.6"
+   "pygments_lexer": "ipython3",
+   "version": "3.6.9"
   },
   "pycharm": {
    "stem_cell": {
     "cell_type": "raw",
-    "source": [],
     "metadata": {
      "collapsed": false
-    }
+    },
+    "source": []
    }
   }
  },
  "nbformat": 4,
- "nbformat_minor": 0
-}
+ "nbformat_minor": 1
+}