Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------------
Expand Down
12 changes: 8 additions & 4 deletions docs/templates.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/mwouts/jupytext>`_, 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 <https://github.com/mwouts/jupytext>`_, 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
Expand All @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion notebooker/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.3.1"
__version__ = "0.3.2"
2 changes: 1 addition & 1 deletion notebooker/web/static/package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down