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

Various updates

Browse source
This commit is contained in:
Tom van Woudenberg 2024-11-29 11:15:59 +01:00
parent edb7789d15
commit 1f0b0f47ee
11 changed files with 18 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

2
book/external/JupyterBook-Patches vendored

@ -1 +1 @@
Subproject commit 2eabe4ab901626d164dbaad36e2f348a59993ad5
Subproject commit 5c129f2447bb4b30100c136d94b5bee9e51e2921

2
book/external/Sphinx-Grasple-public vendored

@ -1 +1 @@
Subproject commit be602551986dfb6d0764be7908f8306709c00845
Subproject commit c29b4a03351c88fa5cdd09475f99a1b486a0e247

2
book/external/Sphinx-Image-Inverter vendored

@ -1 +1 @@
Subproject commit 8693992718956fea78e96af81eb27a2815a737bc
Subproject commit c9c9d2f6953b5a57ff4763976840ec3bb281dbcf

2
book/external/Sphinx-TUDelft-theme vendored

@ -1 +1 @@
Subproject commit bb57b6ebefa51e2705f75d72e5c93c2dfa9364c7
Subproject commit 0f4758586bebb1db4da0738b66d02d883ff7b54d

2
book/external/TeachBooks vendored

@ -1 +1 @@
Subproject commit 4a2e75494b213c9a03615087bab2788f6188da2f
Subproject commit eb5f90c86e6f9dd368c513b2d958f77fb941cae0

2
book/external/annotater vendored

@ -1 +1 @@
Subproject commit df36ccffd4a980d97e90f667c5d5e6bdd941fdbd
Subproject commit 7cd38dbba9ab50eebc5dbba6c61b9cb4f46d3cf0

2
book/external/deploy-book-workflow vendored

@ -1 +1 @@
Subproject commit b6476a0997331d16b000715881f0044e6c68e297
Subproject commit 71dd5f2f56c8540fa45ce713adf44cab9d85c36e

2
book/external/teachbooks-sphinx-tippy vendored

@ -1 +1 @@
Subproject commit 2a06428e894f41fd29f6c2184c504aa90d20ff03
Subproject commit 546f58fe01a556130f06cdc95524efd922362f83

18
book/features/sphinx_extensions.md
View file

@ -1,22 +1,8 @@
# Sphinx Extensions
# Additional functionality
```{admonition} User types
:class: tip
This section is useful for user type 4-5.
```
Sphinx extensions are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities and can be added to Jupyter Book for extra functionality. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file.
At TeachBooks, we have many TA's working on developing cool and handy extensions to use in our books. Here's an overview:
- Download link replacer: Controls the download options of the chapters in your book.
- Image Inverter: Makes it possible to distinguish figures and graphs that shouldn't automatically be converted by the dark/light mode.
- Custom Launch Button: Allows you to add buttons to your book which you can use as quick access or settings options.
- JupyterBook Patches: Fixes an issue where drop down menus would still take up space after being minimized.
- TU Delft theme: Provides a simple solution to have a uniform theme across all the books created at Delft University of Technology that matches the TU Delft identity.
- Rich hover over tips: This TeachBooks Tippy extension utilizes Sphinx-tippy and makes it plug-and-play within a JupyterBook.
This sections includes the features developed by TeachBooks which add functionality to the book. Most of them are implemented as sphinx extensions, which are plugins developed for the Sphinx documentation ecosystem (which Jupyter Book is built upon). They extend or modify Sphinx’s capabilities. Since Sphinx extensions are not an integral part of jupyter-book, as opposed to original jupyter-book features, they must be installed and configured explicitly, for example in the `_config.yml` file.

8
book/features/visuals.md Normal file
View file

@ -0,0 +1,8 @@
# Book styling
```{admonition} User types
:class: tip
This section is useful for user type 1-5.
```
TeachBooks developed a few improvements of the book which improve the visual book styling.

1
book/visuals.md
View file

@ -1 +0,0 @@
# hi