Skip to content

Commit 3eb7d35

Browse files
authored
Generated jupyter notebook cell ids (required for jupyter notebook format 4.5+) (#808)
* [ci/rtd_env] remove explicit requirement for nbformat * [doc/sphinx] updated moved xarray intersphinx mapping * generated ids
1 parent d2b7684 commit 3eb7d35

9 files changed

+294
-2
lines changed

doc/conf.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,7 @@ def _copy_tut_files():
281281
"python": ("https://docs.python.org/3/", None),
282282
"numpy": ("https://numpy.org/doc/stable", None),
283283
"pandas": ("https://pandas.pydata.org/pandas-docs/stable", None),
284-
"xarray": ("https://xarray.pydata.org/en/stable", None),
284+
"xarray": ("https://docs.xarray.dev/en/stable/objects.inv", None),
285285
"scipy": (f"https://docs.scipy.org/doc/scipy-{_scipy_version}/", None),
286286
"matplotlib": ("https://matplotlib.org/stable", None),
287287
# "dask": ("https://docs.dask.org/en/latest", None),

doc/rtd_environment.yml

-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@ dependencies:
2020
# documentation
2121
- sphinx>=4.1.1
2222
- jinja2=3.0
23-
- nbformat<5.5.0 # pending https://github.com/BAMWelDX/weldx/actions/runs/3125636543/jobs/5070212013
2423
- nbsphinx
2524
- sphinx-copybutton
2625
- pydata-sphinx-theme

tutorials/01_01_introduction.ipynb

+13
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
"cells": [
33
{
44
"cell_type": "markdown",
5+
"id": "4182dcd6",
56
"metadata": {},
67
"source": [
78
"# Introduction / Opening WelDX Files\n",
@@ -43,6 +44,7 @@
4344
{
4445
"cell_type": "code",
4546
"execution_count": null,
47+
"id": "ae81c166",
4648
"metadata": {
4749
"collapsed": false,
4850
"jupyter": {
@@ -63,6 +65,7 @@
6365
{
6466
"cell_type": "code",
6567
"execution_count": null,
68+
"id": "36c514ee",
6669
"metadata": {},
6770
"outputs": [],
6871
"source": [
@@ -71,6 +74,7 @@
7174
},
7275
{
7376
"cell_type": "markdown",
77+
"id": "e3ec375b",
7478
"metadata": {},
7579
"source": [
7680
"WelDX files usually have the extension `.weldx` or `.wx`, but any other is also possible as long as the content is valid.\n",
@@ -81,6 +85,7 @@
8185
{
8286
"cell_type": "code",
8387
"execution_count": null,
88+
"id": "630bd97c",
8489
"metadata": {},
8590
"outputs": [],
8691
"source": [
@@ -89,6 +94,7 @@
8994
},
9095
{
9196
"cell_type": "markdown",
97+
"id": "0d183782",
9298
"metadata": {},
9399
"source": [
94100
"### Inspecting the file content in a Jupyter session\n",
@@ -104,6 +110,7 @@
104110
{
105111
"cell_type": "code",
106112
"execution_count": null,
113+
"id": "d7ac29d4",
107114
"metadata": {
108115
"tags": []
109116
},
@@ -114,6 +121,7 @@
114121
},
115122
{
116123
"cell_type": "markdown",
124+
"id": "988d0409",
117125
"metadata": {},
118126
"source": [
119127
"### Inspecting the File content with pure Python\n",
@@ -129,6 +137,7 @@
129137
{
130138
"cell_type": "code",
131139
"execution_count": null,
140+
"id": "9863459a",
132141
"metadata": {},
133142
"outputs": [],
134143
"source": [
@@ -137,6 +146,7 @@
137146
},
138147
{
139148
"cell_type": "markdown",
149+
"id": "85eb6e37",
140150
"metadata": {},
141151
"source": [
142152
"The `info` method lists the internal file structure converted to python objects.\n",
@@ -147,6 +157,7 @@
147157
{
148158
"cell_type": "code",
149159
"execution_count": null,
160+
"id": "b5d960ec",
150161
"metadata": {},
151162
"outputs": [],
152163
"source": [
@@ -156,6 +167,7 @@
156167
},
157168
{
158169
"cell_type": "markdown",
170+
"id": "84a697ce",
159171
"metadata": {},
160172
"source": [
161173
"The output confirms that the object we got is truly of type `VGroove`.\n",
@@ -164,6 +176,7 @@
164176
},
165177
{
166178
"cell_type": "markdown",
179+
"id": "078d2b27",
167180
"metadata": {},
168181
"source": [
169182
"## Conclusion\n",

0 commit comments

Comments
 (0)