From 231c8abe17589497230e2d112eace5461fdf21a2 Mon Sep 17 00:00:00 2001 From: Danyaal Masood Date: Tue, 9 Nov 2021 16:27:08 +0000 Subject: [PATCH] Release version 0.3.2, Update docs --- .circleci/config.yml | 4 ++-- CHANGELOG.md | 2 +- docs/conf.py | 2 +- docs/templates.rst | 12 ++++++++---- notebooker/version.py | 2 +- notebooker/web/static/package.json | 2 +- 6 files changed, 14 insertions(+), 10 deletions(-) diff --git a/.circleci/config.yml b/.circleci/config.yml index 250b2fbf..1a471b7f 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -177,7 +177,7 @@ jobs: PYTHON_VERSION: "3_6" CIRCLE_ARTIFACTS: /tmp/circleci-artifacts/3_6 CIRCLE_TEST_REPORTS: /tmp/circleci-test-results/3_6 - VERSION: 0.3.1 + VERSION: 0.3.2 PANDOC_RELEASES_URL: https://github.com/jgm/pandoc/releases YARN_STATIC_DIR: notebooker/web/static/ IMAGE_NAME: mangroup/notebooker @@ -189,7 +189,7 @@ jobs: environment: CIRCLE_ARTIFACTS: /tmp/circleci-artifacts/3_7 CIRCLE_TEST_REPORTS: /tmp/circleci-test-results/3_7 - VERSION: 0.3.1 + VERSION: 0.3.2 PANDOC_RELEASES_URL: https://github.com/jgm/pandoc/releases YARN_STATIC_DIR: notebooker/web/static/ IMAGE_NAME: mangroup/notebooker diff --git a/CHANGELOG.md b/CHANGELOG.md index 57be76b5..5a5fd7ea 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,4 @@ -0.3.2 (2021-11-??) +0.3.2 (2021-11-10) ------------------ * Feature: .ipynb files are now natively supported and can be used as Notebook Templates (#57) diff --git a/docs/conf.py b/docs/conf.py index d1d8063b..f8fe958c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -23,7 +23,7 @@ author = "Man Group Quant Tech" # The full version, including alpha/beta/rc tags -release = "0.3.1" +release = "0.3.2" # -- General configuration --------------------------------------------------- diff --git a/docs/templates.rst b/docs/templates.rst index 7363c8a2..83584cf4 100644 --- a/docs/templates.rst +++ b/docs/templates.rst @@ -5,11 +5,15 @@ Intro to Notebook Templates Creating a Notebook Template ---------------------------- +Both :code:`ipynb` and :code:`py` file types are supported for use as templates. + To create a Notebook Template, we use a tool called :code:`jupytext`. It allows for interchangeably converting between :code:`.ipynb` and :code:`.py` files. -To create your own template from an existing :code:`.ipynb` file, you can either -follow the instructions for installation `on their homepage `_, or -use :code:`convert_ipynb_to_py` directly from the console when Notebooker is installed. + +If you would like to convert an existing :code:`.ipynb` file to create a template in +:code:`.py` form you can either follow the instructions for installation +`on their homepage `_, or use :code:`convert_ipynb_to_py` +directly from the console when Notebooker is installed. The purpose of a notebook template is to allow you to write Jupyter notebooks as normal, and then commit them into source control as python files: allowing for simple diffs and control @@ -19,7 +23,7 @@ Where should templates go? -------------------------- It is possible (and encouraged) to use a separate git repository version controlling notebook templates. To use a git repository as a notebook templates repository, you simply need to create a folder called -:code:`notebook_templates/` which contains the .py template files. Additionally, a +:code:`notebook_templates/` which contains the :code:`.py` and :code:`.ipynb` template files. Additionally, a :code:`notebook_requirements.txt`, containing extra package requirements to be installed, should be added to that folder. diff --git a/notebooker/version.py b/notebooker/version.py index 260c070a..f9aa3e11 100644 --- a/notebooker/version.py +++ b/notebooker/version.py @@ -1 +1 @@ -__version__ = "0.3.1" +__version__ = "0.3.2" diff --git a/notebooker/web/static/package.json b/notebooker/web/static/package.json index 8a12fd76..5866510e 100644 --- a/notebooker/web/static/package.json +++ b/notebooker/web/static/package.json @@ -1,6 +1,6 @@ { "name": "notebooker", - "version": "0.3.1", + "version": "0.3.2", "description": "Notebooker - Turn notebooks into reports", "dependencies": { "bootstrap-table": "1.15.3",