From a53bcd9c0e6482467d746035f11cf398624bc43c Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Mon, 2 Sep 2024 22:07:49 +0200 Subject: [PATCH 1/4] readability --- book/features/custom_toc.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/features/custom_toc.md b/book/features/custom_toc.md index b75a238..77cbae7 100644 --- a/book/features/custom_toc.md +++ b/book/features/custom_toc.md @@ -6,7 +6,7 @@ This section is useful for user type 3-5. ``` -A feature to enable viewing of work-in-progress (e.g., in the draft book) or testing of content (e.g., interactive programming pages) while preventing students from seeing it is available via the {ref}`teachbooks-package `. Lines of text in a `*.yml` file can be removed prior to the book build process by surrounding the lines with a tag `REMOVE-FROM-PUBLISH`. For example, pages in a draft book (e.g., `main` branch) can be manually stripped out of the table of contents when a merge request from `main` to `publish`, preventing the page being included in the published book. Pages marked with this feature are still visible in the draft book and books build from source on personal computers. Lines tagged in the configuration file `_config.yml` can be used in exactly the same manner. The tag is applied as follows: +A feature to enable viewing of work-in-progress (e.g., in the draft book) or testing of content (e.g., interactive programming pages) while preventing students from seeing it is available via the {ref}`teachbooks-package `. Lines of text in a `*.yml` file can be removed prior to the book build process by surrounding the lines with a tag `REMOVE-FROM-PUBLISH`. For example, pages in a draft book (e.g., `main` branch) can be manually stripped out of the table of contents when a merge request from `main` to `publish` is made. This prevents the page being included in the published book. Pages marked with this feature are still visible in the draft book and books build from source on personal computers. Lines tagged in the configuration file `_config.yml` can be used in exactly the same manner. The tag is applied as follows: ``` format: jb-book @@ -29,7 +29,7 @@ To invoke the tag and remove content during the book build process, use the foll teachbooks build --publish book ``` -Note that `teachbooks build book` would build a book without stripping the tagged lines, just as `jupyter book build book` would. +Note that `teachbooks build book` would build a book without stripping the tagged lines, just as `jupyter-book build book` would. ```{note} The `REMOVE-FROM-PUBLISH` feature was originally deployed using Bash and Shell scripts in the pipeline of our book build processes. The MUDE book contained the scripts on the server, whereas the `interactivetextbooks-citg` contained this in the GitLab CI files or `*.sh` scripts. These workflows will eventually be replaced with a simplified pipeline setup (i.e., a GitLab CI file or GitHub workflow) that uses the commands `teachbooks build book` and `teachbook build --publish book` for the published and draft versions of the book, resepctively. We recommend you do the same. A working example can be found in our [Template repository workflow on GitHub](https://github.com/TeachBooks/deploy-book-workflow/blob/main/.github/workflows/deploy-book.yml) or in the [MUDE book on GitLab](https://gitlab.tudelft.nl/mude/book/-/blob/main/.gitlab-ci.yml?ref_type=heads). From abe8ff51e96428829a3e729b0fbe7570d052715e Mon Sep 17 00:00:00 2001 From: Freek Pols Date: Wed, 4 Sep 2024 17:35:41 +0200 Subject: [PATCH 2/4] Update equations.md --- book/basic-features/equations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/basic-features/equations.md b/book/basic-features/equations.md index 89c5a4e..e521872 100644 --- a/book/basic-features/equations.md +++ b/book/basic-features/equations.md @@ -17,7 +17,7 @@ $$ ```{tip} The scientific rules dictate that quantities ($F$, $m$, $a$ etc.) should be printed in italics. Units, however, should not! One can use `\text{m}` in an equation to comply to this rule: -$$ F = m \cdot a = 10 \cdot 9.81 = 98 \text{N} +$$ F = m \cdot a = 10 \cdot 9.81 = 98 \text{N}$$ ``` > **Warning** From f2c64a44939b7f4eac79900b54ca6817ff0a43a6 Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Fri, 6 Sep 2024 15:06:09 +0200 Subject: [PATCH 3/4] correct version? --- book/external/deploy-book-workflow | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 081491b..60ce0d3 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 081491b5f7bd0beecb5663228eaf5ab80b9dd57c +Subproject commit 60ce0d3f721746a1cd4208e9d4e210f8fed5c7f2 From d66b685cc40c7e9769e8353f4b98c0d2c4e54e2b Mon Sep 17 00:00:00 2001 From: Julie Kirsch Date: Fri, 6 Sep 2024 15:07:35 +0200 Subject: [PATCH 4/4] merge --- book/external/deploy-book-workflow | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 60ce0d3..081491b 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 60ce0d3f721746a1cd4208e9d4e210f8fed5c7f2 +Subproject commit 081491b5f7bd0beecb5663228eaf5ab80b9dd57c