From eadc4e90a8818cba19e518372a0fb2a7d05b924a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 16 Dec 2024 14:19:38 +0100 Subject: [PATCH 1/6] Added sphinx launch buttons --- .gitmodules | 3 +++ book/_toc.yml | 2 +- book/external/Sphinx-launch-buttons | 1 + 3 files changed, 5 insertions(+), 1 deletion(-) create mode 160000 book/external/Sphinx-launch-buttons diff --git a/.gitmodules b/.gitmodules index fc993b6..17401a4 100644 --- a/.gitmodules +++ b/.gitmodules @@ -34,3 +34,6 @@ [submodule "book/external/annotater"] path = book/external/annotater url = https://github.com/TeachBooks/annotater +[submodule "book/external/Sphinx-launch-buttons"] + path = book/external/Sphinx-launch-buttons + url = https://github.com/TeachBooks/Sphinx-launch-buttons.git diff --git a/book/_toc.yml b/book/_toc.yml index f91addb..db028c5 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -61,7 +61,7 @@ parts: - file: features/sphinx_extensions.md sections: - file: external/Download-Link-Replacer/README.md - - file: features/custom-launch-button.md + - file: external/Sphinx-launch-buttons/README.md - file: basic-features/utterances.md - file: features/interactive_element.ipynb sections: diff --git a/book/external/Sphinx-launch-buttons b/book/external/Sphinx-launch-buttons new file mode 160000 index 0000000..433341a --- /dev/null +++ b/book/external/Sphinx-launch-buttons @@ -0,0 +1 @@ +Subproject commit 433341aa718d11ea702207bf4c516172e0d51f40 From 9c48de127b0ea9efe8d356cd6a1a0aef9d3b9c3a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 16 Dec 2024 14:25:27 +0100 Subject: [PATCH 2/6] Reapply "Merge pull request #49 from TeachBooks/temp_delete" This reverts commit fcce5c5ed829fcd5845311c504216ebe51d44b0c. --- .gitmodules | 3 --- book/external/latex-to-markdown-conversion | 1 - 2 files changed, 4 deletions(-) delete mode 160000 book/external/latex-to-markdown-conversion diff --git a/.gitmodules b/.gitmodules index 17401a4..84c4939 100644 --- a/.gitmodules +++ b/.gitmodules @@ -7,9 +7,6 @@ [submodule "book/external/deploy-book-workflow"] path = book/external/deploy-book-workflow url = https://github.com/TeachBooks/deploy-book-workflow.git -[submodule "book/external/latex-to-markdown-conversion"] - path = book/external/latex-to-markdown-conversion - url = https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion.git [submodule "book/external/Useful_python_code"] path = book/external/Useful_python_code url = https://github.com/TeachBooks/Useful_python_code.git diff --git a/book/external/latex-to-markdown-conversion b/book/external/latex-to-markdown-conversion deleted file mode 160000 index cb81691..0000000 --- a/book/external/latex-to-markdown-conversion +++ /dev/null @@ -1 +0,0 @@ -Subproject commit cb8169156e5c0150848cf52fb177d0d40934522e From d99bc6b38e4d3600b7fca48f7d057b8901aa3522 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 16 Dec 2024 14:29:32 +0100 Subject: [PATCH 3/6] Update Sphinx-launch-buttons --- book/external/Sphinx-launch-buttons | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/Sphinx-launch-buttons b/book/external/Sphinx-launch-buttons index 433341a..ae75d29 160000 --- a/book/external/Sphinx-launch-buttons +++ b/book/external/Sphinx-launch-buttons @@ -1 +1 @@ -Subproject commit 433341aa718d11ea702207bf4c516172e0d51f40 +Subproject commit ae75d29e6bf1e480967ff4edf69a67c05770bbbe From df5bd3f319c7cc9503c104e0875a46c47450e94f Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 16 Dec 2024 14:34:57 +0100 Subject: [PATCH 4/6] Update Sphinx-launch-buttons --- book/external/Sphinx-launch-buttons | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/Sphinx-launch-buttons b/book/external/Sphinx-launch-buttons index ae75d29..997c7a4 160000 --- a/book/external/Sphinx-launch-buttons +++ b/book/external/Sphinx-launch-buttons @@ -1 +1 @@ -Subproject commit ae75d29e6bf1e480967ff4edf69a67c05770bbbe +Subproject commit 997c7a440885ac881dbe606019aa17e332a4932b From 7c46956bc43b90537a1ac3182b39ed30a373d33e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 17 Dec 2024 15:43:58 +0100 Subject: [PATCH 5/6] Added license stuff --- LICENSE | 2 +- book/credits.md | 1 + book/external/Sphinx-launch-buttons | 2 +- book/references.bib | 8 ++++++++ 4 files changed, 11 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index 0131ab3..f14b8e1 100644 --- a/LICENSE +++ b/LICENSE @@ -392,7 +392,7 @@ Creative Commons may be contacted at creativecommons.org. ======================================================================= -[](external/annotater), [](external/deploy-book-workflow), [](external/Download-Link-Replacer), [](external/JupyterBook-Patches), [](external/Sphinx-Image-Inverter) and [](external/Useful_python_code) are licensed under BSD 3-Clause license: +[](external/annotater), [](external/deploy-book-workflow), [](external/Download-Link-Replacer), [](external/JupyterBook-Patches), [](external/Sphinx-Image-Inverter), [](external/Sphinx-launch-buttons) and [](external/Useful_python_code) are licensed under BSD 3-Clause license: BSD 3-Clause License diff --git a/book/credits.md b/book/credits.md index 443e088..7f04a41 100644 --- a/book/credits.md +++ b/book/credits.md @@ -48,6 +48,7 @@ The following pages are included directly from an external resource and is not e - Page [](./external/Nested-Books/README.md). Original content licensed under CC BY 4.0 license. - Page [](./external/Sphinx-Grasple-public/README.md). Original content licensed under MIT license. - Page [](./external/Sphinx-Image-Inverter/README.md). Original content licensed under BSD 3-Clause license. +- Page [](./external/Sphinx-launch-buttons/README.md). Original content licensed under BSD 3-Clause license. - Page [](./external/Sphinx-TUDelft-theme/README.md). Original content licensed under MIT license. - Page [](./external/teachbooks-sphinx-tippy/README.md). Original content licensed under MIT license. - Page [](./external/template/README.md). Original content licensed under CC BY 4.0 license. diff --git a/book/external/Sphinx-launch-buttons b/book/external/Sphinx-launch-buttons index 997c7a4..8cfd0ba 160000 --- a/book/external/Sphinx-launch-buttons +++ b/book/external/Sphinx-launch-buttons @@ -1 +1 @@ -Subproject commit 997c7a440885ac881dbe606019aa17e332a4932b +Subproject commit 8cfd0ba7ae24c17e51ac0b1924473a908d4062ac diff --git a/book/references.bib b/book/references.bib index 731967f..6ab40b9 100644 --- a/book/references.bib +++ b/book/references.bib @@ -117,4 +117,12 @@ url = {https://github.com/TeachBooks/Useful_python_code}, year = {2024}, note = {Retrieved December, 2024. BSD-3-Clause.} +} + +@misc{launch_buttons, + author = {{TeachBooks}}, + title = {Custom launch buttons}, + url = {https://github.com/TeachBooks/Sphinx-launch-buttons}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.} } \ No newline at end of file From 5832719c1e9b3ad4185323a7dd9c5fa5bffb97a0 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 19 Dec 2024 09:24:03 +0100 Subject: [PATCH 6/6] 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 e90cc85..c6c52fc 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