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

Added JB references

Browse source
This commit is contained in:
Tom van Woudenberg 2024-05-02 08:36:28 +02:00
parent 177e278115
commit 825eb0bf12
6 changed files with 9 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

5
book/_config.yml
View file

@ -1,6 +1,7 @@
title: How to make a TeachBook
author: Tom van Woudenberg, Robert Lanzafame, Max Ramgraber, Caspar Jungbacker, Julie Kirsch
logo: images/TUDelft_logo_rgb.png
author: TU Delft <a href="https://teachbooks.tudelft.nl/">TeachBooks Team</a>, built with <a href="https://jupyterbook.org/">Jupyter Book</a>
logo: images/Logo_without_background.png
copyright: Delft University of Technology, CC BY 4.0
execute:
execute_notebooks: 'off'

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

@ -7,7 +7,7 @@ This section is useful for user type 3-6.
```{warning} Under Construction!
This page will provide a list of some commonly used book features which are all available in the original jupyter book package. However, this page includes best-practises on how to use them.
This page will provide a list of some commonly used book features which are all available in the original <a href="https://jupyterbook.org/"><img style="display:inline-block; height:2em; width:auto" src="../images/logo-wide.svg" alt="Jupyter book"></a> package. However, this page includes best-practises on how to use them.
```
Things to include somewhere:

BIN
book/images/Logo_without_background.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 975 KiB

1
book/images/logo-wide.svg Normal file
View file

@ -0,0 +1 @@
<svg id="Layer_1" data-name="Layer 1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 460.57 104.67"><defs><style>.cls-1{fill:#616161;}.cls-2{fill:#f37726;}</style></defs><title>logo-wide</title><path class="cls-1" d="M281.94,79.3a14.43,14.43,0,0,1-6.71-1.47,12.62,12.62,0,0,1-4.73-4.36l-.66,5.07h-6.2V27.32l-5.94-1V21.68h13.13V43.76a12.27,12.27,0,0,1,4.61-4,14,14,0,0,1,6.42-1.39A13.29,13.29,0,0,1,290.19,41a16.56,16.56,0,0,1,5.29,7.42,30.78,30.78,0,0,1,1.85,11.12v.75a25,25,0,0,1-1.85,10,15.19,15.19,0,0,1-5.29,6.65A14.08,14.08,0,0,1,281.94,79.3Zm-1.83-5.83q5.07,0,7.53-3.6t2.47-9.57v-.75a26.4,26.4,0,0,0-1.1-8,11.71,11.71,0,0,0-3.32-5.4,8.2,8.2,0,0,0-5.65-2,9.48,9.48,0,0,0-5.59,1.61,11.39,11.39,0,0,0-3.62,4.3V67.52a11.22,11.22,0,0,0,3.65,4.35A9.63,9.63,0,0,0,280.11,73.47ZM322,79.3a16.31,16.31,0,0,1-15.53-9.67,24,24,0,0,1-2.14-10.37v-.8a24,24,0,0,1,2.14-10.38A17,17,0,0,1,312.57,41a17,17,0,0,1,24.87,7.11,23.79,23.79,0,0,1,2.16,10.39v.8a24,24,0,0,1-2.16,10.4A16.15,16.15,0,0,1,322,79.3Zm0-5.61a8.83,8.83,0,0,0,5.75-1.87,11.64,11.64,0,0,0,3.5-5.14,21.67,21.67,0,0,0,1.19-7.42v-.8A21.63,21.63,0,0,0,331.24,51a11.36,11.36,0,0,0-3.53-5.14,9.81,9.81,0,0,0-11.55,0,11.31,11.31,0,0,0-3.5,5.14,22.15,22.15,0,0,0-1.15,7.42v.8a22.19,22.19,0,0,0,1.15,7.42,11.43,11.43,0,0,0,3.52,5.14A9,9,0,0,0,322,73.69Zm42.25,5.61a16.31,16.31,0,0,1-15.53-9.67,24,24,0,0,1-2.14-10.37v-.8a24,24,0,0,1,2.14-10.38A17,17,0,0,1,354.82,41a17,17,0,0,1,24.87,7.11,23.79,23.79,0,0,1,2.16,10.39v.8a24,24,0,0,1-2.16,10.4,16.15,16.15,0,0,1-15.45,9.64Zm0-5.61A8.83,8.83,0,0,0,370,71.82a11.64,11.64,0,0,0,3.5-5.14,21.67,21.67,0,0,0,1.19-7.42v-.8A21.63,21.63,0,0,0,373.49,51,11.36,11.36,0,0,0,370,45.9a9.81,9.81,0,0,0-11.55,0,11.31,11.31,0,0,0-3.5,5.14,22.15,22.15,0,0,0-1.15,7.42v.8a22.19,22.19,0,0,0,1.15,7.42,11.43,11.43,0,0,0,3.52,5.14A9,9,0,0,0,364.24,73.69Zm22.06,4.85v-4.6l5.95-1V27.32l-5.95-1V21.68h13.12V72.93l5.94,1v4.6Zm25.34,0v-4.6l4-.47-.11-.15L404.13,58.6l3.71-5.72,15.94,20.19,5.69.87v4.6ZM398.92,67.13l-2.67-5.66,17.14-17.06.17-.22-4.22-.47V39.1h17v4.62l-5.06,1Z"/><path class="cls-2" d="M255.8,104.69q-10.41-2.94-14.82-9.35a26.7,26.7,0,0,1-4.4-15.48V68.92q0-6-2.74-9.31t-8.37-3.34V48.42q5.66,0,8.37-3.28t2.74-9.33v-11A26.67,26.67,0,0,1,241,9.31Q245.39,2.93,255.8,0l2.12,6.25a13.4,13.4,0,0,0-8.34,6.7,25.71,25.71,0,0,0-2.49,11.88v11a20.94,20.94,0,0,1-2.25,9.89,15.59,15.59,0,0,1-6.76,6.66,16,16,0,0,1,6.76,6.77,20.78,20.78,0,0,1,2.25,9.79V79.86a25.3,25.3,0,0,0,2.49,11.81,13.71,13.71,0,0,0,8.34,6.71Z"/><path class="cls-2" d="M430.26,104.67l-2.14-6.31a13.72,13.72,0,0,0,8.26-6.7,25.07,25.07,0,0,0,2.52-11.81V68.91a20.07,20.07,0,0,1,2.4-10,15.7,15.7,0,0,1,7.43-6.57,15.15,15.15,0,0,1-7.43-6.46,20.25,20.25,0,0,1-2.4-10.09v-11a25.44,25.44,0,0,0-2.52-11.87,13.45,13.45,0,0,0-8.26-6.7L430.26,0Q440.61,2.92,445,9.3a26.66,26.66,0,0,1,4.4,15.51v11q0,6,2.72,9.33c1.83,2.18,4.64,3.28,8.44,3.28v7.84q-5.7,0-8.44,3.35t-2.72,9.31V79.85A26.7,26.7,0,0,1,445,95.33Q440.62,101.73,430.26,104.67Z"/><path class="cls-1" d="M11.28,40.9V82.57c0,3.36-.65,5.9-2,7.61S6,92.74,3.19,92.74c-.52,0-1,0-1.56,0L0,92.6V88.8l.94,0h.92c2,0,3.29-.4,3.89-1.31a7,7,0,0,0,.91-3.9V40.9Zm13.43,0V65.57A11.82,11.82,0,0,0,27,73.13C28.43,75,31,75.94,34.77,75.94a9.73,9.73,0,0,0,8.38-4.25A17.84,17.84,0,0,0,46.2,61.05V40.9h4.6V78.74H46.55v-6.8h-.14a13.73,13.73,0,0,1-5.26,5.82,14.77,14.77,0,0,1-7.81,2.09q-6.81,0-10-3.61T20.09,65.77V40.9Zm52.75-1.08q7.94,0,12.46,5.56t4.54,14.45q0,8.85-4.55,14.44T77.49,79.85a15.38,15.38,0,0,1-8.16-2.22,11.57,11.57,0,0,1-5-6.09h-.15v21.2H59.55V40.9h4.26v7.18H64A12.58,12.58,0,0,1,69.24,42,15.8,15.8,0,0,1,77.46,39.82Zm-13.3,20q0,7.19,3.45,11.67t9.85,4.47a10.53,10.53,0,0,0,9.07-4.59,19.27,19.27,0,0,0,3.3-11.52,19.26,19.26,0,0,0-3.3-11.53,10.63,10.63,0,0,0-9.18-4.61q-6.41,0-9.8,4.05T64.16,59.8ZM102.3,40.9l12.46,32.21L126.44,40.9h4.61L114.76,84.15a19.6,19.6,0,0,1-3.57,6.5c-1.3,1.39-3.42,2.09-6.38,2.09l-1.64-.08a6.87,6.87,0,0,1-2-.28V88.47h.06a5.64,5.64,0,0,0,1.28.25,12.83,12.83,0,0,0,1.8.14,5.4,5.4,0,0,0,4.36-1.75c1-1.16,2.27-4,3.84-8.51L97.39,40.9Zm40.64-11.36V40.9h7.69v3.9h-7.69V70.61c0,1.93.36,3.2,1.08,3.8a4.28,4.28,0,0,0,2.81.89c.48,0,1,0,1.71,0s1.35-.1,2.09-.18V79c-.67,0-1.34.09-2,.11s-1.36,0-2.06,0q-4.62,0-6.44-1.75c-1.19-1.17-1.79-3.26-1.79-6.3V44.8h-6.63V40.9h6.63V29.54Zm28.49,10.28a14.74,14.74,0,0,1,12.17,5.59q4.49,5.58,4.49,14.89v.75H159a16.8,16.8,0,0,0,3.53,10.75,11,11,0,0,0,8.92,4.14A11.79,11.79,0,0,0,179,73.57a13.62,13.62,0,0,0,4.3-7.28H188q-1.62,6.83-5.66,10.2t-10.86,3.36q-8,0-12.55-5.36t-4.53-14.66q0-8.8,4.55-14.4T171.43,39.82Zm12,17.37a15,15,0,0,0-3.53-9.56,11.22,11.22,0,0,0-16.83-.28A17.33,17.33,0,0,0,159,57.19Zm28.4-16.79H213V45h-.54a12.91,12.91,0,0,0-9.84,3.92,13.65,13.65,0,0,0-3.7,9.76v20h-4.61V40.9h4.26v8.87h.14a14.74,14.74,0,0,1,5.21-6.91A13.46,13.46,0,0,1,211.86,40.4Z"/></svg>
Side by side

After

Width:  |  Height:  |  Size: 4.7 KiB

4
book/installation-and-setup/jupyter-book-setup.md
View file

@ -5,11 +5,11 @@
This page is useful for user type 5.
```
Jupyter Book is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository.
<a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto" src="../images/logo-wide.svg" alt="Jupyter book"></a> is a regular Python package which converts our content into a website. It's part of all of the `requirements.txt` files for a book repository.
## Build a book
As soon as you've installed your book environment with jupyter-book you can build your book locally. The official [jupyter-book](https://jupyterbook.org/en/stable/basics/build.html) documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates:
As soon as you've installed your book environment with jupyter-book you can build your book locally. The official <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto" src="../images/logo-wide.svg" alt="Jupyter book"></a> documentation is quite extensive. Only two notes: first navigate to the directory where your book is to leave out the `path-to-book` and use `--all` whenever building a book to make sure the table of contents fully updates:
```
jupyter-book build <path-to-book> --all

4
book/intro.md
View file

@ -1,6 +1,6 @@
# TeachBooks Manual
This is an introduction to Git, VS Code and Jupyter Books for teachers and teaching assistants involved in TeachBooks. This book is still work in progress, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! For more information about teachbooks, visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/).
This is an introduction to Git, VS Code and Jupyter Books for teachers and teaching assistants involved in TeachBooks, our platform easing the process off making a <a href="https://jupyterbook.org/"><img style="display:inline-block; height:1.5em; width:auto" src="images/logo-wide.svg" alt="Jupyter book"></a>. This book is still work in progress, so feel free to contribute https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual! For more information about teachbooks, visit [https://teachbooks.tudelft.nl/](https://teachbooks.tudelft.nl/).
## Contact
If you encounter any issues, please contact Tom van Woudenberg, Robert Lanzafame or one of our TAs Caspar Jungbacker or Julie Kirsch at TeachBooks@tudelft.nl.
If you encounter any issues, please contact Tom van Woudenberg, Robert Lanzafame or one of our TAs Julie Kirsch at TeachBooks@tudelft.nl.