Skip to content

Commit afae4ab

Browse files
author
ci-doc-deploy-bot
committed
[skip ci] docs build of aca4493
1 parent 2e24b7e commit afae4ab

File tree

61 files changed

+1094
-1347
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+1094
-1347
lines changed

_images/01-classic.gif

1.3 MB
Loading

_images/02-jupyterlab.gif

1.93 MB
Loading

_sources/content/mooreslaw-tutorial.ipynb

Lines changed: 49 additions & 49 deletions
Large diffs are not rendered by default.

_sources/content/pairing.ipynb

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5-
"id": "d3524bbb",
5+
"id": "c824f4ac",
66
"metadata": {},
77
"source": [
88
"# Pairing Jupyter notebooks and MyST-NB\n",
@@ -76,7 +76,7 @@
7676
{
7777
"cell_type": "code",
7878
"execution_count": 1,
79-
"id": "3ea645a8",
79+
"id": "c50821b4",
8080
"metadata": {},
8181
"outputs": [
8282
{
@@ -94,7 +94,7 @@
9494
},
9595
{
9696
"cell_type": "markdown",
97-
"id": "52ec280c",
97+
"id": "b92685fe",
9898
"metadata": {},
9999
"source": [
100100
"---\n",
@@ -219,34 +219,32 @@
219219
"\n",
220220
"You can pair the two formats in the classic Jupyter, Jupyter Lab,\n",
221221
"or the command line:\n",
222-
"<ul>\n",
223-
"<details>\n",
224-
" <summary>\n",
225-
" <b>1. Classic Jupyter Jupytext pairing</b>.\n",
226-
" </summary>\n",
227-
" <img src=\"../_static/01-classic.gif\" width=80% height=80%>\n",
228-
"</details>\n",
229-
" \n",
230-
"<details>\n",
231-
" <summary>\n",
232-
" <b>2. Jupyter Lab Jupytext pairing</b>\n",
233-
" </summary>\n",
234-
"\t<img src=\"../_static/02-jupyterlab.gif\" width=80% height=80%>\n",
235-
"</details>\n",
236-
"\n",
237-
"<details>\n",
238-
" <summary>\n",
239-
"\t\t<b>3. Command line Jupytext pairing</b>\n",
240-
" </summary>\n",
241-
" <pre><code>\n",
242-
" jupytext --set-formats ipynb,myst notebook.ipynb\n",
243-
" </pre></code>\n",
244-
" Then, update either the MyST markdown or notebook file:\n",
245-
" <pre><code>\n",
246-
" jupytext --sync notebook.ipynb\n",
247-
" </pre></code>\n",
248-
"</details>\n",
249-
"</ul>\n",
222+
"\n",
223+
"```{admonition} **1. Classic Jupyter Jupytext pairing**\n",
224+
":class: toggle\n",
225+
"\n",
226+
"![Animation showing pairing with Jupyter classic](_static/01-classic.gif)\n",
227+
"```\n",
228+
"\n",
229+
"```{admonition} **2. JupyterLab Jupytext pairing**\n",
230+
":class: toggle\n",
231+
"\n",
232+
"![Animation showing pairing with JupyterLab](_static/02-jupyterlab.gif)\n",
233+
"```\n",
234+
"\n",
235+
"````{admonition} **3. Command line Jupytext pairing**\n",
236+
":class: toggle\n",
237+
"\n",
238+
"```sh\n",
239+
"jupytext --set-formats ipynb,myst notebook.ipynb\n",
240+
"```\n",
241+
"\n",
242+
"Then, update either the MyST markdown or notebook file:\n",
243+
"\n",
244+
"```sh\n",
245+
"jupytext --sync notebook.ipynb\n",
246+
"```\n",
247+
"````\n",
250248
"\n",
251249
"> __Note:__ With Jupytext installed, the classic Jupyter interface will\n",
252250
"> automatically open MyST files as notebooks. In JupyterLab, you can\n",

_sources/content/pairing.md.txt

Lines changed: 26 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -204,34 +204,32 @@ to include the Jupytext extension.
204204

205205
You can pair the two formats in the classic Jupyter, Jupyter Lab,
206206
or the command line:
207-
<ul>
208-
<details>
209-
<summary>
210-
<b>1. Classic Jupyter Jupytext pairing</b>.
211-
</summary>
212-
<img src="../_static/01-classic.gif" width=80% height=80%>
213-
</details>
214-
215-
<details>
216-
<summary>
217-
<b>2. Jupyter Lab Jupytext pairing</b>
218-
</summary>
219-
<img src="../_static/02-jupyterlab.gif" width=80% height=80%>
220-
</details>
221-
222-
<details>
223-
<summary>
224-
<b>3. Command line Jupytext pairing</b>
225-
</summary>
226-
<pre><code>
227-
jupytext --set-formats ipynb,myst notebook.ipynb
228-
</pre></code>
229-
Then, update either the MyST markdown or notebook file:
230-
<pre><code>
231-
jupytext --sync notebook.ipynb
232-
</pre></code>
233-
</details>
234-
</ul>
207+
208+
```{admonition} **1. Classic Jupyter Jupytext pairing**
209+
:class: toggle
210+
211+
![Animation showing pairing with Jupyter classic](_static/01-classic.gif)
212+
```
213+
214+
```{admonition} **2. JupyterLab Jupytext pairing**
215+
:class: toggle
216+
217+
![Animation showing pairing with JupyterLab](_static/02-jupyterlab.gif)
218+
```
219+
220+
````{admonition} **3. Command line Jupytext pairing**
221+
:class: toggle
222+
223+
```sh
224+
jupytext --set-formats ipynb,myst notebook.ipynb
225+
```
226+
227+
Then, update either the MyST markdown or notebook file:
228+
229+
```sh
230+
jupytext --sync notebook.ipynb
231+
```
232+
````
235233

236234
> __Note:__ With Jupytext installed, the classic Jupyter interface will
237235
> automatically open MyST files as notebooks. In JupyterLab, you can

_sources/content/save-load-arrays.ipynb

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5-
"id": "7836cbe1",
5+
"id": "4c7ebd77",
66
"metadata": {},
77
"source": [
88
"# Saving and sharing your NumPy arrays\n",
@@ -37,7 +37,7 @@
3737
{
3838
"cell_type": "code",
3939
"execution_count": 1,
40-
"id": "08eb047b",
40+
"id": "444fa297",
4141
"metadata": {},
4242
"outputs": [],
4343
"source": [
@@ -46,7 +46,7 @@
4646
},
4747
{
4848
"cell_type": "markdown",
49-
"id": "a9528cfe",
49+
"id": "082e6280",
5050
"metadata": {},
5151
"source": [
5252
"In this tutorial, you will use the following Python, IPython magic, and NumPy functions:\n",
@@ -64,7 +64,7 @@
6464
},
6565
{
6666
"cell_type": "markdown",
67-
"id": "a07f1604",
67+
"id": "a5d9d041",
6868
"metadata": {},
6969
"source": [
7070
"---\n",
@@ -81,7 +81,7 @@
8181
{
8282
"cell_type": "code",
8383
"execution_count": 2,
84-
"id": "fe503083",
84+
"id": "f40dc1a9",
8585
"metadata": {},
8686
"outputs": [
8787
{
@@ -102,7 +102,7 @@
102102
},
103103
{
104104
"cell_type": "markdown",
105-
"id": "14f6fda3",
105+
"id": "9c61bbbd",
106106
"metadata": {},
107107
"source": [
108108
"## Save your arrays with NumPy's [`savez`](https://numpy.org/doc/stable/reference/generated/numpy.savez.html?highlight=savez#numpy.savez)\n",
@@ -125,7 +125,7 @@
125125
{
126126
"cell_type": "code",
127127
"execution_count": 3,
128-
"id": "e1056640",
128+
"id": "62d00793",
129129
"metadata": {},
130130
"outputs": [],
131131
"source": [
@@ -134,7 +134,7 @@
134134
},
135135
{
136136
"cell_type": "markdown",
137-
"id": "89c69be3",
137+
"id": "ad6c077a",
138138
"metadata": {},
139139
"source": [
140140
"## Remove the saved arrays and load them back with NumPy's [`load`](https://numpy.org/doc/stable/reference/generated/numpy.load.html#numpy.load)\n",
@@ -159,7 +159,7 @@
159159
{
160160
"cell_type": "code",
161161
"execution_count": 4,
162-
"id": "f63d21f2",
162+
"id": "5b013941",
163163
"metadata": {},
164164
"outputs": [],
165165
"source": [
@@ -169,7 +169,7 @@
169169
{
170170
"cell_type": "code",
171171
"execution_count": 5,
172-
"id": "08ec351a",
172+
"id": "cbf3084c",
173173
"metadata": {},
174174
"outputs": [
175175
{
@@ -189,7 +189,7 @@
189189
{
190190
"cell_type": "code",
191191
"execution_count": 6,
192-
"id": "20305431",
192+
"id": "eb43efa1",
193193
"metadata": {},
194194
"outputs": [
195195
{
@@ -209,7 +209,7 @@
209209
{
210210
"cell_type": "code",
211211
"execution_count": 7,
212-
"id": "f56e63ac",
212+
"id": "8b7a437d",
213213
"metadata": {},
214214
"outputs": [
215215
{
@@ -218,7 +218,7 @@
218218
"text": [
219219
"Variable Type Data/Info\n",
220220
"-------------------------------\n",
221-
"load_xy NpzFile <numpy.lib.npyio.NpzFile <...>object at 0x7f914c07e340>\n",
221+
"load_xy NpzFile <numpy.lib.npyio.NpzFile <...>object at 0x7f96c6872490>\n",
222222
"np module <module 'numpy' from '/ho<...>kages/numpy/__init__.py'>\n"
223223
]
224224
}
@@ -229,7 +229,7 @@
229229
},
230230
{
231231
"cell_type": "markdown",
232-
"id": "7cddf75a",
232+
"id": "e73371f7",
233233
"metadata": {},
234234
"source": [
235235
"## Reassign the NpzFile arrays to `x` and `y`\n",
@@ -242,7 +242,7 @@
242242
{
243243
"cell_type": "code",
244244
"execution_count": 8,
245-
"id": "b582f479",
245+
"id": "706887c1",
246246
"metadata": {},
247247
"outputs": [
248248
{
@@ -263,7 +263,7 @@
263263
},
264264
{
265265
"cell_type": "markdown",
266-
"id": "5afec78e",
266+
"id": "8413b048",
267267
"metadata": {},
268268
"source": [
269269
"## Success\n",
@@ -294,7 +294,7 @@
294294
{
295295
"cell_type": "code",
296296
"execution_count": 9,
297-
"id": "9ff79c3e",
297+
"id": "2eb23e94",
298298
"metadata": {},
299299
"outputs": [
300300
{
@@ -323,7 +323,7 @@
323323
},
324324
{
325325
"cell_type": "markdown",
326-
"id": "0e4827a7",
326+
"id": "c5130dc0",
327327
"metadata": {},
328328
"source": [
329329
"## Save the data to csv file using [`savetxt`](https://numpy.org/doc/stable/reference/generated/numpy.savetxt.html#numpy.savetxt)\n",
@@ -338,7 +338,7 @@
338338
{
339339
"cell_type": "code",
340340
"execution_count": 10,
341-
"id": "34e1e077",
341+
"id": "b5dad981",
342342
"metadata": {},
343343
"outputs": [],
344344
"source": [
@@ -347,7 +347,7 @@
347347
},
348348
{
349349
"cell_type": "markdown",
350-
"id": "aa6c2416",
350+
"id": "782fa301",
351351
"metadata": {},
352352
"source": [
353353
"Open the file, `x_y-squared.csv`, and you'll see the following:\n",
@@ -387,7 +387,7 @@
387387
{
388388
"cell_type": "code",
389389
"execution_count": 11,
390-
"id": "19035a5b",
390+
"id": "0e872120",
391391
"metadata": {},
392392
"outputs": [],
393393
"source": [
@@ -397,7 +397,7 @@
397397
{
398398
"cell_type": "code",
399399
"execution_count": 12,
400-
"id": "22d43d64",
400+
"id": "1aee7d2d",
401401
"metadata": {},
402402
"outputs": [],
403403
"source": [
@@ -409,7 +409,7 @@
409409
{
410410
"cell_type": "code",
411411
"execution_count": 13,
412-
"id": "5c6dbccf",
412+
"id": "b381bf46",
413413
"metadata": {},
414414
"outputs": [
415415
{
@@ -430,7 +430,7 @@
430430
{
431431
"cell_type": "code",
432432
"execution_count": 14,
433-
"id": "05420dc2",
433+
"id": "2209f649",
434434
"metadata": {},
435435
"outputs": [
436436
{
@@ -451,7 +451,7 @@
451451
},
452452
{
453453
"cell_type": "markdown",
454-
"id": "d0524cd6",
454+
"id": "c607c33c",
455455
"metadata": {},
456456
"source": [
457457
"## Success, but remember your types\n",
@@ -462,7 +462,7 @@
462462
},
463463
{
464464
"cell_type": "markdown",
465-
"id": "945b8483",
465+
"id": "c3db6a3d",
466466
"metadata": {},
467467
"source": [
468468
"## Wrapping up\n",

0 commit comments

Comments
 (0)