Skip to content
Snippets Groups Projects
Commit 45f03bb2 authored by Robert Lanzafame's avatar Robert Lanzafame
Browse files

Merge branch 'prepare-interactive-pages-for-sharing' into 'main'

Prepare interactive pages for sharing

See merge request !42
parents 94def4b8 f7678d32
No related branches found
No related tags found
1 merge request!42Prepare interactive pages for sharing
Pipeline #205755 passed
# MUDE Jupyter Book 2023/2024
**UPDATE FOR THOSE BUILDING THE BOOK:** _we've been adding packages to the build, for example, Tom has added some examples of the quiz features we can use in the Cookbook, which requires a special package from our CS colleagues. If your book build is breaking due to package issues, simply run the following:_
**UPDATE FOR THOSE BUILDING THE BOOK:** _we've been adding a lot of functionality related to interactive features, for example, Python code that runs in your browser, and Tom has added some examples of the quiz features we can use in the Cookbook. You can still use the "normal" approach of building the book with_ `jupyter book build book` _but if you want to use the interactive features, see the instructions in the Live Code chapter of the Cookbook. If your book build with the "normal" is breaking due to package issues, simply run the following:_
```
pip install -r requirements.txt
......
# Cookbook
Examples. Don't forget to check our [other book](https://interactivetextbooks.citg.tudelft.nl/manual/intro.html), the [repo for the other book](https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual)and the [Jupyter Book website](https://jupyterbook.org/en/stable/).
\ No newline at end of file
This Part of the book is a collection point for various instructions and examples. In particular, the following chapters lay out two types of interactive features:
1. non-code examples (e.g., how to make different types of quiz questions)
2. code examples. This is brand new and unique to MUDE; it is now possible to run Python code directly in the book!
Especially for type 2, there is a lot of potential for providing immediate feedback to students when they run a code cell, but this is not documented extensively yet. **For those developing educational content:** if you know how you want to implement a particular type of question in your book, *send Robert a description as soon as possible!* For example, "I want to have students write a function to implement method A, and when they run the code cell they see if it gives the right answer. It will be checked by confirming a few inputs and outputs of the function, but I don't want the students to see the correct answer (values nor function code)."
_This book temporarily supercedes the Cookbook in our other (non-MUDE) book (links to: [website](https://interactivetextbooks.citg.tudelft.nl/) and [repo](https://gitlab.tudelft.nl/interactivetextbooks-citg/jupyter-book-manual)). Prior to Q1 starting, the content here will be moved o the other book._
Remember to visit the [Jupyter Book website](https://jupyterbook.org/en/stable/) for basic functionality, and create a GitLab issue if you still have problems or questions.
\ No newline at end of file
# Live Code
Our book has been enable to run Python code live in the browser (thanks Max!). Detailed instructions will be added elsewhere later, but for now, try this:
Our book has been enable to run Python code live in the browser (thanks Max!). This page contains some installation instructions, and the other sections in this chapter provide some Benchmarks which illustrate the functionality that has been added (note that examples for how this functionality can be used in an educational context is still missing). See also the next chapter in the Cookbook, where Tom has implemented an example with widgets working in the browser!
Detailed instructions will be added elsewhere later, but for now, try the following steps to use the interactive features on your local computer. If you would like to see them live on the MUDE website, create a Merge Request and tag Robert for review. Note that by the beginning of Q1 these examples will be moved to the generic Manual [here](https://interactivetextbooks.citg.tudelft.nl/intro.html).
## Instructions: local build
1. build the book by running the shell script `build-book.sh` (type `./build-book.sh true` in the terminal)
2. Open the book by going to [http://127.0.0.1:8000/](http://127.0.0.1:8000/) in your browser, or use the "live" version of the book at [https://mude.citg.tudelft.nl/book-draft/](https://mude.citg.tudelft.nl/book-draft/)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment