From 93064802b97436b0b3c48405161820ed370b1449 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Mon, 11 Nov 2024 14:51:20 +0100 Subject: [PATCH 1/8] Deleted from TU Delft --- book/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 57d128f..a9aadc3 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,5 +1,5 @@ title: Template -author: TeachBooks Team from Delft University of Technology, built with TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here +author: TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here logo: figures/TB_logo.png #add your own logo here execute: From f0002390acd62d37aed217d0c50e0f08a60d2246 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 14 Nov 2024 16:18:36 +0100 Subject: [PATCH 2/8] Update credits.md --- book/credits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/credits.md b/book/credits.md index c57f07c..ceaeb3c 100644 --- a/book/credits.md +++ b/book/credits.md @@ -17,7 +17,7 @@ We anticipate that the content of this book will change significantly. Therefore ## How the book is made -This book is created using open source tools: it is a Jupyter Book that is written using Markdown, Jupyter notebooks and Python files to generate some figures. The files are stored on a [public GitHub repository](``). The website can be viewed at ``. View the repository README file or contact the authors for additional information. +This book is created using open source tools: it is a JupyterBook that is written using Markdown and Jupyter notebooks. Additional tooling is used from the [TeachBooks initiative](https://teachbooks.io/) to enhance the editing and reading experience. The files are stored on a [public GitHub repository](``). The website can be viewed at ``. View the repository README file or contact the authors for additional information. (editor)= ## About the Editors From ce0bd6764b78dab1630c6197c64551123ae6d835 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 14 Nov 2024 18:22:37 +0100 Subject: [PATCH 3/8] Remove urls to prevent unintended references to template repo --- book/_config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index a9aadc3..db6bb25 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -9,7 +9,7 @@ only_build_toc_files: true html: favicon : "figures/TB_favicon.ico" - baseurl : "https://teachbooks.github.io/template/" #Replace this with your own URL + baseurl : "url" #Replace this with your own URL sphinx: config: @@ -19,7 +19,7 @@ sphinx: use_thebe_lite: true exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] html_theme_options: - repository_url: "https://github.com/TeachBooks/template" #add your own repo URL here + repository_url: "url" #add your own repo URL here use_repository_button: true use_issues_button : true launch_buttons: From 69e593180d88072a86fcba2607ca2a4134bec463 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 14 Nov 2024 18:25:22 +0100 Subject: [PATCH 4/8] Fix? --- book/_config.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index db6bb25..a5762af 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -19,9 +19,9 @@ sphinx: use_thebe_lite: true exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] html_theme_options: - repository_url: "url" #add your own repo URL here - use_repository_button: true - use_issues_button : true + # repository_url: "url" #add your own repo URL here + # use_repository_button: true + # use_issues_button : true launch_buttons: thebe: true html_show_copyright: false From 7bf044b130c383756f94443a48adc74f5359ecc2 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Thu, 14 Nov 2024 18:28:40 +0100 Subject: [PATCH 5/8] Fix? --- book/_config.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index a5762af..852a228 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -9,7 +9,7 @@ only_build_toc_files: true html: favicon : "figures/TB_favicon.ico" - baseurl : "url" #Replace this with your own URL + baseurl : "https://teachbooks.io/" #Replace this with your own URL sphinx: config: @@ -19,9 +19,9 @@ sphinx: use_thebe_lite: true exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] html_theme_options: - # repository_url: "url" #add your own repo URL here - # use_repository_button: true - # use_issues_button : true + repository_url: "https://github.com/user/repo" #add your own repo URL here + use_repository_button: true + use_issues_button : true launch_buttons: thebe: true html_show_copyright: false From 767193cb17218e7faeedba67edec6845148bf2b6 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Fri, 15 Nov 2024 17:14:50 +0100 Subject: [PATCH 6/8] Update _config.yml --- book/_config.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/book/_config.yml b/book/_config.yml index 852a228..44d6641 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -20,6 +20,9 @@ sphinx: exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] html_theme_options: repository_url: "https://github.com/user/repo" #add your own repo URL here + path_to_docs: "book" + repository_branch: "main" + use_edit_page_button: true use_repository_button: true use_issues_button : true launch_buttons: From cd79fb0e66880cd56a750ed993d0ea23784462a3 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sat, 16 Nov 2024 14:52:23 +0100 Subject: [PATCH 7/8] Update _config.yml --- book/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 44d6641..58e0c7d 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,5 +1,5 @@ title: Template -author: TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here +author: TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0 #add your own name here logo: figures/TB_logo.png #add your own logo here execute: From 4973a6e55e8ff873f0c4f197e6bf1e6baca3f40e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sat, 16 Nov 2024 15:05:37 +0100 Subject: [PATCH 8/8] Updated links to teachbooks.io --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a110da5..b4cb428 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Your first TeachBook using the GitHub template -The template allows you to start your own TeachBook and hosting that TeachBook online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. Please look at our manual (https://teachbooks.tudelft.nl/jupyter-book-manual) to find more about that! +The template allows you to start your own TeachBook and hosting that TeachBook online without knowledge on Git, the Jupyter book package, python or anaconda. It doesn't elaborate on the collaborative functionalities of Git or how to edit the book. Please look at our manual (https://teachbooks.io/manual) to find more about that! ## Features - A github repository structure for making a [Jupyter Book](https://github.com/executablebooks/jupyter-book) (`/book`) @@ -8,7 +8,7 @@ The template allows you to start your own TeachBook and hosting that TeachBook o - A file ready for adding references (`references.bib`, `/book/references.md`) - An example favicon (web browser icon) (`/book/figures/favicon.ico`, `book/_config.yml`.) - An example logo (`/book/figures/TUDelft_logo_rgb.png`, `/book/config.yml`) -- The configuration files set ready to make your Jupyter Notebooks pages work with [live code using our sphinx-thebe extension](https://teachbooks.tudelft.nl/jupyter-book-manual/features/live_code.html) and our recommended settings (`/book/config.yml`) +- The configuration files set ready to make your Jupyter Notebooks pages work with [live code using our sphinx-thebe extension](https://teachbooks.io/manual/features/live_code.html) and our recommended settings (`/book/config.yml`) - An example of setting up preprocessing your table of contents to hide certain draft chapters for eg. students (`_toc.yml`) - A file containing all the recommended software packages (`requirements.txt`) - A file containing the recommended license CC BY 4.0 (`LICENSE.md`) @@ -52,4 +52,4 @@ Set the repository website as your GitHub Pages website under `Code`- `About` - ![GitHub pages as website](figures/use_github_pages_website.png) ## Contribute -This tool's repository is stored on [GitHub](https://github.com/TeachBooks/template). The `README.md` of the branch `manual_description` is also part of the [TeachBooks manual](https://teachbooks.tudelft.nl/jupyter-book-manual/external/template/README.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/template). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitLab repository of the manual](https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual). If you intent to clone the manual including its submodules, clone using: `git clone --recurse-submodules git@gitlab.tudelft.nl:interactivetextbooks-citg/jupyter-book-manual.git`. +This tool's repository is stored on [GitHub](https://github.com/TeachBooks/template). The `README.md` of the branch `manual_description` is also part of the [TeachBooks manual](https://teachbooks.io/manual/external/template/README.html) as a submodule. If you'd like to contribute, you can create a fork and open a pull request on the [GitHub repository](https://github.com/TeachBooks/template). To update the `README.md` shown in the TeachBooks manual, create a fork and open a merge request for the [GitHub repository of the manual](https://github.com/TeachBooks/manual). If you intent to clone the manual including its submodules, clone using: `git clone --recurse-submodulesgit@github.com:TeachBooks/manual.git`.