From 1d5d7d82924de5ddb0b926490f1d1807cbb94739 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 17 Dec 2024 16:09:06 +0100 Subject: [PATCH 1/3] added yaml formatting --- book/features/live_code.ipynb | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/features/live_code.ipynb b/book/features/live_code.ipynb index a923219..8406c69 100644 --- a/book/features/live_code.ipynb +++ b/book/features/live_code.ipynb @@ -55,7 +55,7 @@ "\n", "Afterwards, this sphinx extension needs to be enabled in your book. This can be done by adding the following lines to `_config.yml`:\n", "\n", - "```\n", + "```yaml\n", "launch_buttons:\n", " thebe: true\n", "\n", @@ -78,7 +78,7 @@ "\n", "Note, if you're messing around with `html_theme_options` (for example when adding more buttons), all button behaviour is affected. In that case, as opposed to the jupyter book documentation, all buttons have to be specified from within `sphinx: html_theme_options` where you might also specify other buttons as well (ie. the [code repository button](https://jupyterbook.org/en/stable/basics/repository.html)).\n", "\n", - "```\n", + "```yaml\n", "sphinx:\n", " config:\n", " html_js_files:\n", From 8908b65f327b6f49fa3a2a7cfbfc65a6b866ad0d Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 19 Dec 2024 09:24:03 +0100 Subject: [PATCH 2/3] moved over exercises to template --- book/_toc.yml | 8 -------- book/external/template | 2 +- book/intro/template.md | 12 +++++++++--- book/intro/workshop/06.md | 13 ------------- book/intro/workshop/07.md | 11 ----------- 5 files changed, 10 insertions(+), 36 deletions(-) delete mode 100644 book/intro/workshop/06.md delete mode 100644 book/intro/workshop/07.md diff --git a/book/_toc.yml b/book/_toc.yml index a002345..79151fd 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -7,14 +7,6 @@ parts: - file: intro/book.md - file: intro/workflow.md - file: intro/template.md - sections: - - file: external/template/book/exercises/001.md - - file: external/template/book/exercises/002.md - - file: external/template/book/exercises/003.md - - file: external/template/book/exercises/004.md - - file: external/template/book/exercises/005.md - - file: external/template/book/exercises/006.md - - file: intro/workshop/summary - file: intro/next.md - caption: Getting Going! chapters: diff --git a/book/external/template b/book/external/template index 337ba8f..08fd386 160000 --- a/book/external/template +++ b/book/external/template @@ -1 +1 @@ -Subproject commit 337ba8f1dec89e7e29e9bad1520c5ee1302cf89e +Subproject commit 08fd386338a9ffe590e3face43dd5db170cb215a diff --git a/book/intro/template.md b/book/intro/template.md index 32dad92..c84e81c 100644 --- a/book/intro/template.md +++ b/book/intro/template.md @@ -26,12 +26,18 @@ Go to the [TeachBooks Template repository on GitHub](https://github.com/TeachBoo ``` ## 3. Let's practice! -Getting used to the syntax of writing in a Jupyter Book can be a bit daunting at the start, not to mention becoming familiar with the various tools and workflows required. To help make the learning curve somewhat easier to travel, a number of exercises have been prepared for you as part of an introductory **workshop**. The exercises are designed such that no prior experience with any tools or programming is required, as long as you have read the preceding introductory pages. +Getting used to the syntax of writing in a Jupyter Book can be a bit daunting at the start, not to mention becoming familiar with the various tools and workflows required. To help make the learning curve somewhat easier to travel, a number of exercises have been prepared for you The exercises are designed such that no prior experience with any tools or programming is required, as long as you have read the preceding introductory pages. -```{exercise} -Work through the exercises attached to this page (you can find them in the left sidebar). These exercises can also be found in the template book itself. +The exercises can be found in your book at `https://.github.io//exercises/exercises` (case sensitive) or at https://teachbooks.io/template/exercises/exercises.html. + +```{figure} ../external/template/figures/exercises.png +--- +name: exercises +width: 200px +align: center ``` + ```{tip} Maybe you're already comfortable with Git, GitHub and the concept of using software to parse text-based files and create marked-up documents. In that case, can you answer the following questions (refering to the exercises): 1. Can you add some content to the intro page? diff --git a/book/intro/workshop/06.md b/book/intro/workshop/06.md deleted file mode 100644 index 0691015..0000000 --- a/book/intro/workshop/06.md +++ /dev/null @@ -1,13 +0,0 @@ -# Exercise 6: Submit for Review - -Now we make a PR and merge it. - - -```{admonition} Check your understanding -:class: tip - -Before moving on to the next exercise, make sure you understand the following: -1. Where is the Table of Contents defined? -... -``` - diff --git a/book/intro/workshop/07.md b/book/intro/workshop/07.md deleted file mode 100644 index 850b019..0000000 --- a/book/intro/workshop/07.md +++ /dev/null @@ -1,11 +0,0 @@ -# Exercise 7: Collaborate - -Fork, PR, merge. - -```{admonition} Check your understanding -:class: tip - -Before moving on to the next exercise, make sure you understand the following: -1. What is a fork? -... -``` \ No newline at end of file From 429f75f96a013b2a82beba34d3931c2786c264c2 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 19 Dec 2024 09:29:03 +0100 Subject: [PATCH 3/3] Update template --- book/external/template | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/template b/book/external/template index 08fd386..6bacc35 160000 --- a/book/external/template +++ b/book/external/template @@ -1 +1 @@ -Subproject commit 08fd386338a9ffe590e3face43dd5db170cb215a +Subproject commit 6bacc354c7e924ee91dd462abbd23eecf0d154ea