Skip to content

Commit

Permalink
add frontmatter to core; add templated vars to index; use quarto …
Browse files Browse the repository at this point in the history
…directive convention
  • Loading branch information
seeM committed Aug 16, 2022
1 parent 2224a35 commit 4bed9f3
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
28 changes: 20 additions & 8 deletions 00_core.ipynb
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
{
"cells": [
{
"cell_type": "raw",
"metadata": {},
"source": [
"---\n",
"title: core\n",
"output-file: core.html\n",
"description: Fill in a module description here\n",
"---"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand All @@ -10,12 +21,13 @@
]
},
{
"cell_type": "markdown",
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# module name here\n",
"\n",
"> API details."
"#| hide\n",
"from nbdev.showdoc import *"
]
},
{
Expand All @@ -24,8 +36,8 @@
"metadata": {},
"outputs": [],
"source": [
"#|hide\n",
"from nbdev.showdoc import *"
"#| export\n",
"def foo(): pass"
]
},
{
Expand All @@ -34,8 +46,8 @@
"metadata": {},
"outputs": [],
"source": [
"#|export\n",
"def foo(): pass"
"#| hide\n",
"import nbdev; nbdev.nbdev_export()"
]
}
],
Expand Down
12 changes: 6 additions & 6 deletions index.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
"metadata": {},
"outputs": [],
"source": [
"#|hide\n",
"from your_lib.core import *"
"#| hide\n",
"from {{lib_path}}.core import *"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Project name here\n",
"# {{repo}}\n",
"\n",
"> Summary description here."
"> {{description}}"
]
},
{
Expand All @@ -38,7 +38,7 @@
"metadata": {},
"source": [
"```sh\n",
"pip install your_project_name\n",
"pip install {{lib_path}}\n",
"```"
]
},
Expand Down Expand Up @@ -86,7 +86,7 @@
],
"metadata": {
"kernelspec": {
"display_name": "Python 3.9.7 ('base')",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
}
Expand Down

0 comments on commit 4bed9f3

Please sign in to comment.