admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 06:45:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Jupyterbook v1 and teachbooks

Browse source
This commit is contained in:
Tom van Woudenberg 2025-11-03 17:48:38 +01:00
parent 4311f11d16
commit fdf2d7c5ef
57 changed files with 88 additions and 89 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/workflows/collaboration.md
View file

@ -7,7 +7,7 @@ This page is useful for user type 3, 4 and 5.
# Collaborative book-editing
A jupyter book is composed out of many files which contain the educational content produced by you. Through the use of branches it is possible to work on the book at the same time as your team-members. Working on content for the book is mainly individual work, the beauty of Git comes in when everybody's changes are merged into the main branch.
A TeachBook is composed out of many files which contain the educational content produced by you. Through the use of branches it is possible to work on the book at the same time as your team-members. Working on content for the book is mainly individual work, the beauty of Git comes in when everybody's changes are merged into the main branch.
We have previously introduced the notions of using Git in the online environment (remote) or locally. All the (text, figures, etc.) files that make up the book are contained on the remote repository on GitLab or GitHub. This could be on an open repository on `gitlab.com` or `github.com`. In the context of creating educational books for students at TU Delft, the repository will most likely be located on `github.com` or `gitlab.tudelft.nl`. If this is the first time you interact with books, you're advise to use `github.com`.

2
book/workflows/edit_book.md
View file

@ -1,6 +1,6 @@
# Edit (merge conflicts, staging, committing, pushing)
Suppose we are writing a new chapter, or are updating an existing chapter for our Jupyter Book. We've created a new branch on which we are going to make the changes.
Suppose we are writing a new chapter, or are updating an existing chapter for our TeachBook. We've created a new branch on which we are going to make the changes.
**Edit files as ...**
`````````{tab-set}

2
book/workflows/user45_check_changes.md
View file

@ -20,7 +20,7 @@ Then we can build the book locally. Make sure you are in the right repository in
teachbooks build <path-to-book>
```
Note: use `--all` for the jupyter-book whenever building a book to make sure the table of contents fully updates. Or alternatively, delete the old `_build` folder before building the new book.
Note: use `--all` for the TeachBook whenever building a book to make sure the table of contents fully updates. Or alternatively, delete the old `_build` folder before building the new book.
Where book is the name of the folder containing all the files that make up your book. After `teachbooks` is done running you will get the following: