@@ -5,11 +5,15 @@ Intro to Notebook Templates
5
5
6
6
Creating a Notebook Template
7
7
----------------------------
8
+ Both :code: `ipynb ` and :code: `py ` file types are supported for use as templates.
9
+
8
10
To create a Notebook Template, we use a tool called :code: `jupytext `.
9
11
It allows for interchangeably converting between :code: `.ipynb ` and :code: `.py ` files.
10
- To create your own template from an existing :code: `.ipynb ` file, you can either
11
- follow the instructions for installation `on their homepage <https://github.com/mwouts/jupytext >`_, or
12
- use :code: `convert_ipynb_to_py ` directly from the console when Notebooker is installed.
12
+
13
+ If you would like to convert an existing :code: `.ipynb ` file to create a template in
14
+ :code: `.py ` form you can either follow the instructions for installation
15
+ `on their homepage <https://github.com/mwouts/jupytext >`_, or use :code: `convert_ipynb_to_py `
16
+ directly from the console when Notebooker is installed.
13
17
14
18
The purpose of a notebook template is to allow you to write Jupyter notebooks as normal, and then
15
19
commit them into source control as python files: allowing for simple diffs and control
@@ -19,7 +23,7 @@ Where should templates go?
19
23
--------------------------
20
24
It is possible (and encouraged) to use a separate git repository version controlling notebook templates.
21
25
To use a git repository as a notebook templates repository, you simply need to create a folder called
22
- :code: `notebook_templates/ ` which contains the .py template files. Additionally, a
26
+ :code: `notebook_templates/ ` which contains the :code: ` .py ` and :code: ` .ipynb ` template files. Additionally, a
23
27
:code: `notebook_requirements.txt `, containing extra package requirements to be
24
28
installed, should be added to that folder.
25
29
0 commit comments