From cdf3c1b8db58335792343d94b38c71b7b86e308b Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Mon, 9 Sep 2024 15:25:43 +0200 Subject: [PATCH 1/4] addition of external/TeachBooks --- .gitmodules | 3 +++ book/external/TeachBooks | 1 + 2 files changed, 4 insertions(+) create mode 160000 book/external/TeachBooks diff --git a/.gitmodules b/.gitmodules index 64687ac..80ce81d 100644 --- a/.gitmodules +++ b/.gitmodules @@ -13,3 +13,6 @@ [submodule "book/external/Useful_python_code"] path = book/external/Useful_python_code url = https://github.com/TeachBooks/Useful_python_code.git +[submodule "book/external/TeachBooks"] + path = book/external/TeachBooks + url = https://github.com/TeachBooks/TeachBooks.git diff --git a/book/external/TeachBooks b/book/external/TeachBooks new file mode 160000 index 0000000..cfab2f9 --- /dev/null +++ b/book/external/TeachBooks @@ -0,0 +1 @@ +Subproject commit cfab2f9facf8c3ddba9bcd91cfdade9541cfb361 From 657c4e213c63eedff9f7138994551cec814de65a Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Mon, 9 Sep 2024 16:19:57 +0200 Subject: [PATCH 2/4] adding links and fixing typos --- book/features/h5p.md | 2 +- book/features/live_code.ipynb | 2 +- book/features/overview.md | 26 +++++++++++++------------- 3 files changed, 15 insertions(+), 15 deletions(-) diff --git a/book/features/h5p.md b/book/features/h5p.md index 463dcab..853b822 100644 --- a/book/features/h5p.md +++ b/book/features/h5p.md @@ -6,7 +6,7 @@ This section is useful for user type 3-5. ``` ## Instruction -H5p elements are interactive HTML-blocks which can be imbeded in a Jupyter Book using an iframe. H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file: +H5p elements are interactive HTML-blocks which can be embedded in a Jupyter Book using an iframe. An H5p element can be created in the [TU Delft portal on the H5p website](https://tudelft.h5p.com/content) (sign in via Brightspace to H5p required first). The iframe code can be copied at Edit - Publish - Public - Embed code. This html code can be directly added to your markdown file: ```html diff --git a/book/features/live_code.ipynb b/book/features/live_code.ipynb index 9d900a8..7288cae 100644 --- a/book/features/live_code.ipynb +++ b/book/features/live_code.ipynb @@ -37,7 +37,7 @@ "sphinx-thebe ~= 0.9.9\n", "```\n", "\n", - "This will download the correct version of the sphinx extension when the book is build on the server (which loads the required packages from `requirements.txt`)\n", + "This will download the correct version of the sphinx extension when the book is built on the server (which loads the required packages from `requirements.txt`)\n", "\n", "If you want to build the book locally, you need to install this version of sphinx-thebe in your environment as well with:\n", "```\n", diff --git a/book/features/overview.md b/book/features/overview.md index bb0cecd..2241a6f 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -1,6 +1,6 @@ # TeachBooks Features -We collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is esential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching! +As TeachBooks, we collect a suite of existing open-source software and keep our books up-to-date so you don't have to! Some of the software is developed with our TA's to improve the learning experience of our students and ease the book-development process for our teachers. By deploying these tools from a central location we can prevent common problems before they arise, and fix them quickly when they do occur. As the open-source software landscape changes rapidly, it is essential to keep in contact and share resources amongst ourselves to minimize maintenance and downtime for our book websites and focus on what really matters: teaching! This chapter provides a list of commonly used book features together with sub-pages that provide additional information on: - the purpose @@ -9,17 +9,17 @@ This chapter provides a list of commonly used book features together with sub-pa - where to find the source code Overview of features covered: -- Interaction on the website: Adding comments and feedback to content on the website -- Grasple Questions: Explanation how to embed Grasple questions in the book. -- Adding interactive h5p elements: Embedding interactive HTML-blocks in the book -- Exclude parts of book from published book -- Page download options -- Python-enabled interactivity: Run Python code live in the browser - - Widgets - - Exercise checking using check-answer button -- JupyterLite-Sphinx: Including interactive pieces of content in the book. - - Configuration - - How to add `JupyterLite` to a page +- Interaction with the book: Adding comments and feedback to content on the website using [Hypothesis](/book/basic-features/hypothesis.md) or [Utterances 🔮](/book/basic-features/utterances.md) +- [Grasple Questions](grasple.md): Embedding Grasple questions in your book +- [H5p elements](h5p.md): Embedding interactive HTML-blocks in your book +- [Exclude draft parts of the book from the published book](custom_toc.md) +- [Page download options](custom_download.md) +- [Python-enabled interactivity](live_code.ipynb): Run Python code live in the browser + - [Widgets](widgets.ipynb) + - [Exercise checking](exercise_checking.ipynb): Using the check-answer button +- [JupyterLite-Sphinx](/book/features/jupyterlite/jupyterlite.md): Including interactive pieces of content in the book. + - [Configuration](/book/features/jupyterlite/configuration.md) + - [Adding `JupyterLite` to a page](/book/features/jupyterlite/including-jupyterlite.md) -To see examples for these features, go to the Example chapter. +To see examples for these features, go to the [Example chapter](/book/examples/overview.md). From 21af99b54e467299a444cd54f88de8f54a02fe67 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Mon, 9 Sep 2024 16:35:01 +0200 Subject: [PATCH 3/4] fixes --- book/_toc.yml | 8 ++++---- book/features/overview.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/book/_toc.yml b/book/_toc.yml index aa2a6b8..f5e0fba 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -36,11 +36,11 @@ parts: - file: basic-features/Code_block_figures - file: basic-features/banner title: Banner or Announcement - - file: basic-features/hypothesis - - file: basic-features/utterances + - file: basic-features/hypothesis.md + - file: basic-features/utterances.md - file: features/overview sections: - - file: features/teachbooks + - file: external/TeachBooks/README.md title: TeachBooks Package - file: external/deploy-book-workflow/README.md - file: features/remove_from_publish @@ -68,7 +68,7 @@ parts: - caption: Examples chapters: - - file: examples/overview + - file: examples/overview.md - file: examples/book_structure.md - file: examples/h5p_examples.md - file: examples/live_code.md diff --git a/book/features/overview.md b/book/features/overview.md index 2241a6f..8c8d195 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -21,5 +21,5 @@ Overview of features covered: - [Configuration](/book/features/jupyterlite/configuration.md) - [Adding `JupyterLite` to a page](/book/features/jupyterlite/including-jupyterlite.md) -To see examples for these features, go to the [Example chapter](/book/examples/overview.md). +To see examples for these features, go to the [Examples chapter](/book/examples/overview.md). From 46dacaf0f0112dd9381f12a2fbdc8541136f6116 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 9 Sep 2024 16:39:47 +0200 Subject: [PATCH 4/4] Update Nested-Books --- book/external/Nested-Books | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/Nested-Books b/book/external/Nested-Books index 7ce10eb..fd06f98 160000 --- a/book/external/Nested-Books +++ b/book/external/Nested-Books @@ -1 +1 @@ -Subproject commit 7ce10eb625c878f1fbd008b67bd266d61461541b +Subproject commit fd06f9871aec3cbb255f3724dc9be77fd8b45ae3