Skip to content

Commit 5663616

Browse files
minrkminrk
authored
Merge pull request #510 from minrk/example-docs
Move examples into docs
2 parents 30504aa + f953e81 commit 5663616

Some content is hidden

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

47 files changed

+514
-571
lines changed

‎docs/requirements.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1+
matplotlib
12
myst-parser
3+
nbsphinx
4+
numpy
25
pydata-sphinx-theme
36
sphinx
47
sphinx-copybutton

‎docs/source/conf.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
'sphinx.ext.intersphinx',
5151
'sphinx.ext.napoleon',
5252
'myst_parser',
53+
'nbsphinx',
5354
'IPython.sphinxext.ipython_console_highlighting',
5455
]
5556

@@ -357,3 +358,8 @@
357358
'distributed': ('https://distributed.readthedocs.io/en/stable/', None),
358359
'jupyterclient': ('https://jupyter-client.readthedocs.io/en/stable/', None),
359360
}
361+
362+
363+
# nbsphinx config
364+
# https://nbsphinx.readthedocs.io/en/latest/usage.html
365+
nbsphinx_execute = 'auto'

‎examples/Cluster API.ipynb renamed to ‎docs/source/examples/Cluster API.ipynb

File renamed without changes.

‎examples/Data Publication API.ipynb renamed to ‎docs/source/examples/Data Publication API.ipynb

Lines changed: 10 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,7 @@
3131
{
3232
"cell_type": "code",
3333
"execution_count": 1,
34-
"metadata": {
35-
"collapsed": false
36-
},
34+
"metadata": {},
3735
"outputs": [],
3836
"source": [
3937
"%matplotlib inline"
@@ -42,9 +40,7 @@
4240
{
4341
"cell_type": "code",
4442
"execution_count": 2,
45-
"metadata": {
46-
"collapsed": false
47-
},
43+
"metadata": {},
4844
"outputs": [],
4945
"source": [
5046
"import ipyparallel as ipp"
@@ -53,9 +49,7 @@
5349
{
5450
"cell_type": "code",
5551
"execution_count": 3,
56-
"metadata": {
57-
"collapsed": false
58-
},
52+
"metadata": {},
5953
"outputs": [
6054
{
6155
"data": {
@@ -92,9 +86,7 @@
9286
{
9387
"cell_type": "code",
9488
"execution_count": 4,
95-
"metadata": {
96-
"collapsed": false
97-
},
89+
"metadata": {},
9890
"outputs": [],
9991
"source": [
10092
"def publish_it():\n",
@@ -112,9 +104,7 @@
112104
{
113105
"cell_type": "code",
114106
"execution_count": 5,
115-
"metadata": {
116-
"collapsed": false
117-
},
107+
"metadata": {},
118108
"outputs": [],
119109
"source": [
120110
"ar = dv.apply_async(publish_it)"
@@ -130,9 +120,7 @@
130120
{
131121
"cell_type": "code",
132122
"execution_count": 6,
133-
"metadata": {
134-
"collapsed": false
135-
},
123+
"metadata": {},
136124
"outputs": [
137125
{
138126
"data": {
@@ -173,9 +161,7 @@
173161
{
174162
"cell_type": "code",
175163
"execution_count": 7,
176-
"metadata": {
177-
"collapsed": false
178-
},
164+
"metadata": {},
179165
"outputs": [],
180166
"source": [
181167
"def simulation_loop():\n",
@@ -197,9 +183,7 @@
197183
{
198184
"cell_type": "code",
199185
"execution_count": 8,
200-
"metadata": {
201-
"collapsed": false
202-
},
186+
"metadata": {},
203187
"outputs": [],
204188
"source": [
205189
"ar = dv.apply_async(simulation_loop)"
@@ -215,9 +199,7 @@
215199
{
216200
"cell_type": "code",
217201
"execution_count": 9,
218-
"metadata": {
219-
"collapsed": false
220-
},
202+
"metadata": {},
221203
"outputs": [],
222204
"source": [
223205
"import matplotlib.pyplot as plt"
@@ -226,9 +208,7 @@
226208
{
227209
"cell_type": "code",
228210
"execution_count": 10,
229-
"metadata": {
230-
"collapsed": false
231-
},
211+
"metadata": {},
232212
"outputs": [
233213
{
234214
"data": {

‎examples/Futures.ipynb renamed to ‎docs/source/examples/Futures.ipynb

Lines changed: 16 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,7 @@
1515
{
1616
"cell_type": "code",
1717
"execution_count": 1,
18-
"metadata": {
19-
"collapsed": false
20-
},
18+
"metadata": {},
2119
"outputs": [
2220
{
2321
"data": {
@@ -47,9 +45,7 @@
4745
{
4846
"cell_type": "code",
4947
"execution_count": 2,
50-
"metadata": {
51-
"collapsed": false
52-
},
48+
"metadata": {},
5349
"outputs": [],
5450
"source": [
5551
"%%px --local\n",
@@ -83,9 +79,7 @@
8379
{
8480
"cell_type": "code",
8581
"execution_count": 4,
86-
"metadata": {
87-
"collapsed": false
88-
},
82+
"metadata": {},
8983
"outputs": [
9084
{
9185
"data": {
@@ -106,9 +100,7 @@
106100
{
107101
"cell_type": "code",
108102
"execution_count": 5,
109-
"metadata": {
110-
"collapsed": false
111-
},
103+
"metadata": {},
112104
"outputs": [
113105
{
114106
"data": {
@@ -135,9 +127,7 @@
135127
{
136128
"cell_type": "code",
137129
"execution_count": 6,
138-
"metadata": {
139-
"collapsed": false
140-
},
130+
"metadata": {},
141131
"outputs": [
142132
{
143133
"data": {
@@ -166,9 +156,7 @@
166156
{
167157
"cell_type": "code",
168158
"execution_count": 7,
169-
"metadata": {
170-
"collapsed": false
171-
},
159+
"metadata": {},
172160
"outputs": [
173161
{
174162
"data": {
@@ -188,9 +176,7 @@
188176
{
189177
"cell_type": "code",
190178
"execution_count": 8,
191-
"metadata": {
192-
"collapsed": false
193-
},
179+
"metadata": {},
194180
"outputs": [
195181
{
196182
"name": "stdout",
@@ -227,9 +213,7 @@
227213
{
228214
"cell_type": "code",
229215
"execution_count": 9,
230-
"metadata": {
231-
"collapsed": false
232-
},
216+
"metadata": {},
233217
"outputs": [
234218
{
235219
"name": "stdout",
@@ -300,9 +284,7 @@
300284
{
301285
"cell_type": "code",
302286
"execution_count": 10,
303-
"metadata": {
304-
"collapsed": false
305-
},
287+
"metadata": {},
306288
"outputs": [
307289
{
308290
"data": {
@@ -323,9 +305,7 @@
323305
{
324306
"cell_type": "code",
325307
"execution_count": 11,
326-
"metadata": {
327-
"collapsed": false
328-
},
308+
"metadata": {},
329309
"outputs": [
330310
{
331311
"name": "stdout",
@@ -361,9 +341,7 @@
361341
{
362342
"cell_type": "code",
363343
"execution_count": 12,
364-
"metadata": {
365-
"collapsed": false
366-
},
344+
"metadata": {},
367345
"outputs": [
368346
{
369347
"data": {
@@ -397,9 +375,7 @@
397375
{
398376
"cell_type": "code",
399377
"execution_count": 20,
400-
"metadata": {
401-
"collapsed": false
402-
},
378+
"metadata": {},
403379
"outputs": [],
404380
"source": [
405381
"from concurrent.futures import ThreadPoolExecutor, ProcessPoolExecutor\n",
@@ -448,9 +424,7 @@
448424
{
449425
"cell_type": "code",
450426
"execution_count": 22,
451-
"metadata": {
452-
"collapsed": false
453-
},
427+
"metadata": {},
454428
"outputs": [
455429
{
456430
"name": "stdout",
@@ -500,9 +474,7 @@
500474
{
501475
"cell_type": "code",
502476
"execution_count": 24,
503-
"metadata": {
504-
"collapsed": false
505-
},
477+
"metadata": {},
506478
"outputs": [
507479
{
508480
"data": {
@@ -532,9 +504,7 @@
532504
{
533505
"cell_type": "code",
534506
"execution_count": 25,
535-
"metadata": {
536-
"collapsed": false
537-
},
507+
"metadata": {},
538508
"outputs": [
539509
{
540510
"name": "stdout",
@@ -561,9 +531,7 @@
561531
{
562532
"cell_type": "code",
563533
"execution_count": 26,
564-
"metadata": {
565-
"collapsed": false
566-
},
534+
"metadata": {},
567535
"outputs": [
568536
{
569537
"name": "stdout",

0 commit comments

Comments
 (0)