From 12e518259744ded26d33a13bb67859c751edf6ea Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 08:59:46 -0700 Subject: [PATCH 1/7] feature overview page --- book/features/overview.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/book/features/overview.md b/book/features/overview.md index 229071c..c4f8b33 100644 --- a/book/features/overview.md +++ b/book/features/overview.md @@ -4,11 +4,11 @@ As TeachBooks, we collect a suite of existing open-source software 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. 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! Since the list of TeachBook features is getting quite long, we have grouped them in categories: -- Original Jupyter Book and Sphinx features -- Easy editing process -- Additional functionality -- Book styling -- TeachBooks student-view features +- [Original Jupyter Book and Sphinx features](../basic-features/overview.md) +- [Easy editing process](./easy-editing.md) +- [Additional functionality](./sphinx_extensions.md) +- [Book styling](./visuals.md) +- [TeachBooks student-view features](./students.md) Additionally, not all features are built and shared in the same way. We do our best to make sure that as many tools as possible are included automatically when using our TeachBooks Template Book; if you are not using the Template, we try to make sure each of our tools can be used independently. For transparency, tags will help differentiate between the different backgrounds of the features: - {bdg-warning}`Javascript overlay` @@ -22,9 +22,9 @@ Additionally, not all features are built and shared in the same way. We do our b - {bdg-link-primary-line}`TeachBooks Favourites <./favourites.html>` - {bdg-danger}`iframe` - {bdg-success}`WebApp` -) -Finally, the purpose, installation process and usage of each features is elaborated on in the respective sub-sections. -To see examples for these features, go to the [Examples chapter](../examples/overview.md). +For each feature, the purpose, installation process and usage is elaborated in the respective sub-sections. -As the [TeachBooks Python Package](./teachbooks_intro.md), the [Deploy Book Workflow](../external/deploy-book-workflow/README.md), [TeachBooks Favourites](./favourites.md) and the [TeachBook template](../external/template/README.md) are important tools that incorporate and deploy more than one feature, an additional explanation is provided here in subpages in more detail, with links to the pages in this manual where individual features are described. \ No newline at end of file +To see examples of these features, go to the [Examples chapter](../examples/overview.md). + +As the [TeachBooks Python Package](./teachbooks_intro.md), the [Deploy Book Workflow](../external/deploy-book-workflow/README.md), [TeachBooks Favourites](./favourites.md) and the [TeachBook template](../external/template/README.md) are important tools that incorporate and deploy more than one feature, an additional explanation is provided here in subpages to this page in more detail, with links to other pages in this manual where individual features are described. \ No newline at end of file From 1cb1b805f861d04af3e233b760a41185abac281e Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 09:02:19 -0700 Subject: [PATCH 2/7] basic-features/overview update --- book/basic-features/overview.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/basic-features/overview.md b/book/basic-features/overview.md index 8790d60..eb75beb 100644 --- a/book/basic-features/overview.md +++ b/book/basic-features/overview.md @@ -7,4 +7,4 @@ This section is useful for [user type 3-5](../installation-and-setup/user_types. # Overview -These pages will provide a list of some common, basic book features which are all available in the original Jupyter book package without addition of any additional software. Additionally, this page includes also best-practices. +These pages itemize some of the more common, basic book features which are all available in the original Jupyter book package, without requiring any additional software. They are, of course, selected with teachers and teaching applications in mind. On each page best-practices are illustrated. From 1b4b25461cac54b5dae585bf69ab82d74a6da6a0 Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 09:59:51 -0700 Subject: [PATCH 3/7] fix figmaker text --- book/tools/figmaker.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/tools/figmaker.md b/book/tools/figmaker.md index 9e9be86..cdd73c8 100644 --- a/book/tools/figmaker.md +++ b/book/tools/figmaker.md @@ -7,7 +7,7 @@ This section is useful for user type 3-5. # Figure syntax maker -One might quickely forget the code for making figures, here is a useful tool to make your figures, just specify all information and the code is produced for you: +One might quickly forget the code for making figures, so here we provide a useful tool to make the source code for figures. Simply specify the information in the empty fields below and the code is produced for you automatically:
From 2fa1592de43e140b41682785afb47128c0f85cab Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 10:02:06 -0700 Subject: [PATCH 4/7] scripts page text --- book/helper_code/intro.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/book/helper_code/intro.md b/book/helper_code/intro.md index 6e8f8e7..b06a321 100644 --- a/book/helper_code/intro.md +++ b/book/helper_code/intro.md @@ -1,6 +1,7 @@ # Scripts for automating workflow -This chapter contains a few scripts which can be useful in the book-editing process: +This chapter contains a few scripts which can be useful in the book-editing process, all of which are scripts and/or files stored in other repositories (they are _not_ Sphinx extensions). + - [LaTeX to markdown conversion](tex_md_converter) to convert a LaTeX file into jupyter-book compatible markdown. - [Snippitall](Snippitall) to insert the same code snippet at a certain point in each md file in a specific folder and all subfolder. - [Snippitonce](Snippitonce) to insert the same code snippet at a certain point in each md file only in a specific folder. From 708f14a6216c5e6c29386d8fc78e66b7816956cc Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 10:10:00 -0700 Subject: [PATCH 5/7] sphinx exercise text --- book/features/exercise.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/features/exercise.md b/book/features/exercise.md index a798ee2..69d5636 100644 --- a/book/features/exercise.md +++ b/book/features/exercise.md @@ -16,9 +16,9 @@ This section is useful for user type 3-5. # Sphinx exercise -This extensions provides an easy way to add exercises and solutions to your book. It is documented on https://ebp-sphinx-exercise.readthedocs.io/en/latest/. +This extensions provides an easy way to add exercises and solutions to your book. It is created by the Executable Books team and is [documented here](https://ebp-sphinx-exercise.readthedocs.io/en/latest/). -TeachBooks has made some small modifications to the original extension, such that it works well with translated books. +TeachBooks has made some small modifications to the original extension, such that it works well with translated books; this modified version is located in the repository [github.com/TeachBooks/sphinx-exercise](https://github.com/TeachBooks/sphinx-exercise). ## What does it do? From 75221ef14dae075285d306285848431b5ad079df Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 10:12:09 -0700 Subject: [PATCH 6/7] favourites text --- book/features/favourites.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/features/favourites.md b/book/features/favourites.md index d747655..2d71de2 100644 --- a/book/features/favourites.md +++ b/book/features/favourites.md @@ -30,7 +30,7 @@ TeachBooks Favourites is a Sphinx extension which collects all of TeachBooks' fa - [Notebook execution patterns](../_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.md) - [Sphinx Launch Buttons](../external/Sphinx-launch-buttons/README.md) -All features which are part of TeachBooks Favourites are indicated with {bdg-primary-line}`Part of TeachBooks Favourites`. If you'd like to use specific features, but not the entire TeachBooks Favourites, you can remove this extension and replace it with the individual extensions you want to use. +All features which are part of TeachBooks Favourites are include the following label on their respective pages in this manual: {bdg-primary-line}`Part of TeachBooks Favourites`. If you'd like to use specific features, but not the entire TeachBooks Favourites, you can remove this extension and replace it with the individual extensions you want to use. ## Installation To install TeachBooks-Favourites, follow these steps: From 83256dda73772d08a99aaa8e81b69079af4e768c Mon Sep 17 00:00:00 2001 From: Robert Lanzafame Date: Mon, 29 Sep 2025 10:17:08 -0700 Subject: [PATCH 7/7] sphinx proof text - copy updated format of exercise --- book/features/sphinx-proof.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/features/sphinx-proof.md b/book/features/sphinx-proof.md index b65a796..7627adb 100644 --- a/book/features/sphinx-proof.md +++ b/book/features/sphinx-proof.md @@ -16,9 +16,9 @@ This section is useful for user type 3-5. # Sphinx proof -This extensions provides an easy way to add proofs, theorem, axioms and much more to your book. It is documented on https://sphinx-proof.readthedocs.io/en/latest/. +This extensions provides an easy way to add proofs, theorem, axioms and much more to your book. It is created by the Executable Books team and is [documented here](https://sphinx-proof.readthedocs.io/en/latest/). -TeachBooks has made some small modifications to the original extension, such that it works well with translated books. +TeachBooks has made some small modifications to the original extension, such that it works well with translated books; this modified version is located in the repository [github.com/TeachBooks/sphinx-proof](https://github.com/TeachBooks/sphinx-proof). ## What does it do?