Overview

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

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:

• Javascript overlay

• Chrome Extension

• GitHub App and Javascript script

• Python Package: teachbooks

• GitHub Reusable Action: Deploy Book workflow

• GitHub Template: TeachBooks Template

• Git Workflow

• Sphinx Extension

• TeachBooks Favourites

• iframe

• WebApp

For each feature, the purpose, installation process and usage is elaborated in the respective sub-sections.

To see examples of these features, go to the Examples chapter.

As the TeachBooks Python Package, the Deploy Book Workflow, TeachBooks Favourites and the TeachBook template 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.