Skip to content

Commit 4bed9f3

Browse files
committed
add frontmatter to core; add templated vars to index; use quarto directive convention
1 parent 2224a35 commit 4bed9f3

File tree

2 files changed

+26
-14
lines changed

2 files changed

+26
-14
lines changed

00_core.ipynb

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
11
{
22
"cells": [
3+
{
4+
"cell_type": "raw",
5+
"metadata": {},
6+
"source": [
7+
"---\n",
8+
"title: core\n",
9+
"output-file: core.html\n",
10+
"description: Fill in a module description here\n",
11+
"---"
12+
]
13+
},
314
{
415
"cell_type": "code",
516
"execution_count": null,
@@ -10,12 +21,13 @@
1021
]
1122
},
1223
{
13-
"cell_type": "markdown",
24+
"cell_type": "code",
25+
"execution_count": null,
1426
"metadata": {},
27+
"outputs": [],
1528
"source": [
16-
"# module name here\n",
17-
"\n",
18-
"> API details."
29+
"#| hide\n",
30+
"from nbdev.showdoc import *"
1931
]
2032
},
2133
{
@@ -24,8 +36,8 @@
2436
"metadata": {},
2537
"outputs": [],
2638
"source": [
27-
"#|hide\n",
28-
"from nbdev.showdoc import *"
39+
"#| export\n",
40+
"def foo(): pass"
2941
]
3042
},
3143
{
@@ -34,8 +46,8 @@
3446
"metadata": {},
3547
"outputs": [],
3648
"source": [
37-
"#|export\n",
38-
"def foo(): pass"
49+
"#| hide\n",
50+
"import nbdev; nbdev.nbdev_export()"
3951
]
4052
}
4153
],

index.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,17 @@
66
"metadata": {},
77
"outputs": [],
88
"source": [
9-
"#|hide\n",
10-
"from your_lib.core import *"
9+
"#| hide\n",
10+
"from {{lib_path}}.core import *"
1111
]
1212
},
1313
{
1414
"cell_type": "markdown",
1515
"metadata": {},
1616
"source": [
17-
"# Project name here\n",
17+
"# {{repo}}\n",
1818
"\n",
19-
"> Summary description here."
19+
"> {{description}}"
2020
]
2121
},
2222
{
@@ -38,7 +38,7 @@
3838
"metadata": {},
3939
"source": [
4040
"```sh\n",
41-
"pip install your_project_name\n",
41+
"pip install {{lib_path}}\n",
4242
"```"
4343
]
4444
},
@@ -86,7 +86,7 @@
8686
],
8787
"metadata": {
8888
"kernelspec": {
89-
"display_name": "Python 3.9.7 ('base')",
89+
"display_name": "Python 3 (ipykernel)",
9090
"language": "python",
9191
"name": "python3"
9292
}

0 commit comments

Comments
 (0)