admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #201 from TeachBooks/favourites-robert

Browse source 
Favourites - additions from robert
This commit is contained in:
Tom van Woudenberg 2025-09-29 20:05:04 +02:00 • committed by GitHub
commit 58217a6cd8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 18 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/basic-features/overview.md
View file

@ -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 <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> 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 <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto; transform:translate(0, -0.15em)" src="../images/logo-wide.svg" alt="Jupyter book"></a> 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.

4
book/features/exercise.md
View file

@ -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?

2
book/features/favourites.md
View file

@ -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:

18
book/features/overview.md
View file

@ -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.
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.

4
book/features/sphinx-proof.md
View file

@ -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?

3
book/helper_code/intro.md
View file

@ -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.

2
book/tools/figmaker.md
View file

@ -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:
<div id="figuur_formulier">