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

Merge branch 'main' into manual_description

Browse source
This commit is contained in:
Tom van Woudenberg 2024-05-31 10:50:34 +02:00
commit 65210ea008
3 changed files with 10 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -23,6 +23,11 @@ The template allows you to start your own Jupyter Book and hosting that book onl
## How to get started ## How to get started
How to use the template is demonstrated in the figure below, followed by a step-by-step tutorial.
![template-demo](figures/teachbooks-template.gif)
The demonstration is also available as a video [here](https://youtu.be/nN3Oi_MVvF0).
1. To get started making your Jupyter Book with our functionalities, use the [template book](https://github.com/TeachBooks/template) as template: 1. To get started making your Jupyter Book with our functionalities, use the [template book](https://github.com/TeachBooks/template) as template:
```{figure} figures/use_template.png ```{figure} figures/use_template.png

BIN
figures/teachbooks-template.gif Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 3.2 MiB

10
requirements.txt
View file

@ -6,10 +6,10 @@ teachbooks # depends on jupyter-book
docutils==0.17.1 docutils==0.17.1
# now list the packages (and the respective url) you wish to download from the GitLab package registry # now list the packages (and the respective url) you wish to download from the GitLab package registry
--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/17983/packages/pypi/simple --extra-index-url https://gitlab.tudelft.nl/api/v4/projects/17983/packages/pypi/simple #temporarily disable
jupyterbook_patches ~= 0.1.4 jupyterbook_patches ~= 0.1.4 #temporarily disable
--extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple --extra-index-url https://gitlab.tudelft.nl/api/v4/projects/11239/packages/pypi/simple #temporarily disable
sphinx-thebe ~= 0.9.9 sphinx-thebe ~= 0.9.9 #temporarily disable
# lastly any packages you wish to download directly from a Git repository # lastly any packages you wish to download directly from a Git repository
download_link_replacer @ git+https://gitlab.tudelft.nl/mude/sphinx-download-link-replacer download_link_replacer @ git+https://gitlab.tudelft.nl/mude/sphinx-download-link-replacer #temporarily disable