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

Added user types, restructured sollaborative book-editing

Browse source
This commit is contained in:
Tom van Woudenberg 2024-04-11 12:28:44 +02:00
parent 87c5cfc910
commit f44ac6bbdd
17 changed files with 332 additions and 115 deletions
Download patch file Download diff file Expand all files Collapse all files

5
book/features/custom_download.md
View file

@ -1,5 +1,10 @@
# Page download options
```{admonition} User types
:class: tip
This section is useful for user type 4-6.
```
You can control the download option of the book in two ways:
- Disabling downloading using cell tags `disable-download-page`
- Add / replace download link with custom link using `spinhx-download-link-replacer`

5
book/features/custom_toc.md
View file

@ -1,5 +1,10 @@
# Exclude parts of book from published book
```{admonition} User types
:class: tip
This section is useful for user type 3-6.
```
A new feature is added to enable testing of all interactive features on the web server (i.e., in the draft book) while preventing students from seeing it. Pages in the draft book (`main` branch) can be manually stripped out of the table of contents when a merge request from `main` to `publish` is made using a tag `REMOVE-FROM-PUBLISH`. Pages marked with this feature are still visible in the draft book and books build from source on personal computers. The tag is applied as follows:
```

5
book/features/python_interactivity.md
View file

@ -1,5 +1,10 @@
# Python-enabled interactivity
```{admonition} User types
:class: tip
This section is useful for user type 5-6.
```
In general, there are two option to include python-enabled interactivity embedded in your book:
- Using our [own sphinx-thebe extension](live_code.md) which makes code cells in your `.ipynb` book pages editable and executable by the reader! Opposed to the original sphinx-thebe extensions, our extension runs python in the reader's browser and doesn't rely on an external webserver for the python kernel. We highly recommend this extension as it allows you to use the strength of combining text/figures and code of a jupyter book with interactivity!
- Using [JupyterLite](jupyterlite/jupyterlite.md) to create 'iframe-like' Ipython consoles / jupyterbook / jupyter lab environments in your book. As these 'iframes' are separate modules added to your page, the integration with the other content in your book is less flexible as with our sphinx-thebe extension.