Skip to content

Commit 19b75f9

Browse files
Quek Ching YeeQuek Ching Yee
authored andcommitted
docs: workflow demonstration rely on jupyter notebook
1 parent b039e31 commit 19b75f9

File tree

2 files changed

+13
-4
lines changed

2 files changed

+13
-4
lines changed

docs/gettingstarted/demo/workflow.ipynb renamed to docs/gettingstarted/demo/Workflow Demonstration.ipynb

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,11 @@
5252
"\n",
5353
"app = AppToDo(\"To Do App\")\n",
5454
"app.add_item(item_name=\"Homework 1\", list_name=\"School\")\n",
55-
"app.add_item(item_name=[\"Milk\", \"Bread\"], list_name=\"Groceries\", description=\"Urgent\")\n",
55+
"app.add_item(\n",
56+
" item_name=[\"Milk\", \"Bread\"],\n",
57+
" list_name=\"Groceries\",\n",
58+
" description=\"Urgent\",\n",
59+
")\n",
5660
"app.add_item(item_name=\"Cook\")\n",
5761
"app.show()"
5862
]
@@ -103,7 +107,12 @@
103107
"\n",
104108
"calendar = Calendar(\"My Calendar\")\n",
105109
"calendar.add_event(\"Gym\", \"2023-01-01 18:00\")\n",
106-
"calendar.add_event(\"Dinner\", \"2023-01-01\", date_format=\"%Y-%m-%d\", budget=20)\n",
110+
"calendar.add_event(\n",
111+
" \"Dinner\",\n",
112+
" \"2023-01-01\",\n",
113+
" date_format=\"%Y-%m-%d\",\n",
114+
" budget=20,\n",
115+
")\n",
107116
"calendar.add_event(\"Gym\", \"2023-01-02 18:00\")\n",
108117
"calendar.show()"
109118
]

mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ nav:
2323
- gettingstarted/demo/tree.md
2424
- gettingstarted/demo/binarytree.md
2525
- gettingstarted/demo/dag.md
26-
- gettingstarted/demo/workflow.md
26+
- gettingstarted/demo/Workflow Demonstration.ipynb
2727
- Resources:
2828
- gettingstarted/resources/articles.md
2929
- gettingstarted/resources/glossary.md
@@ -94,7 +94,7 @@ theme:
9494
plugins:
9595
- glightbox # expand images
9696
- mkdocs-jupyter:
97-
include_source: True
97+
ignore_h1_titles: True
9898
- search
9999
- social:
100100
cards_layout_options:

0 commit comments

Comments
 (0)