diff --git a/book/_config.yml b/book/_config.yml index 6ad58d4..d488258 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -43,6 +43,7 @@ sphinx: - download_link_replacer - sphinx.ext.extlinks - sphinx_image_inverter + - sphinx_iframes - sphinx_exercise - teachbooks_sphinx_tippy diff --git a/book/changelog.md b/book/changelog.md index 729bf67..23465d6 100644 --- a/book/changelog.md +++ b/book/changelog.md @@ -1,4 +1,11 @@ # Changelog -## `` [``](<`link to release on GitHub>`) +## ``: `` - `` [](``) +- ... +- Full Changelog: `[...]()' + +## ``: <...> +- <...> + +<...> diff --git a/book/credits.md b/book/credits.md index 89b23d8..40a0a5e 100644 --- a/book/credits.md +++ b/book/credits.md @@ -3,11 +3,11 @@ You can refer to this book as: -> `` (``) _``_. `<url to book website>`. Source files at `<link to github repo` +> `<editors>` (`<year>`) _`<title>`_. `<url to book website>`. Source files at `<link to github repo`. CC BY 4.0. You can refer to individual chapters or pages within this book as: -> `<Title of Chapter or Page>`. In `<editors>` (`<year>`) _`<title>`_. `<url to specific page on book website>`. Source files at `<link to specific commit / file in github repo` +> `<Title of Chapter or Page>`. In `<editors>` (`<year>`) _`<title>`_. `<url to specific page on book website>`. Source files at `<link to specific commit / file in github repo`. CC BY 4.0. We anticipate that the content of this book will change significantly. Therefore, we recommend using the source code directly with the citation above that refers to the GitHub repository and lists the date and name of the file. Although content will be added over time, chapter titles and URL's in this book are expected to remain relatively static. However, we make no guarantee, so if it is important for you to reference a specific location/commit within the book. diff --git a/book/exercises/001.md b/book/exercises/001.md index 5e56d75..0f059b3 100644 --- a/book/exercises/001.md +++ b/book/exercises/001.md @@ -18,21 +18,20 @@ Can you add some content to the intro page? ````{hint} Watch the steps in action below :class: dropdown - ```{figure} https://github.com/TeachBooks/template_figures/blob/main/excercise1.gif?raw=true ---- -name: template_demo_public ---- +:name: template_demo_public Demonstration of all steps of this exercise, video available [here](https://youtu.be/gn1zBmmunco) ``` ```` -:::{card} Check your understanding -<iframe src="https://home.teachbooks.io/wp-admin/admin-ajax.php?action=h5p_embed&id=2" width="624" height="324" frameborder="0" allowfullscreen="allowfullscreen" title="Testing your knowledge"></iframe><script src="https://home.teachbooks.io/wp-content/plugins/h5p/h5p-php-library/js/h5p-resizer.js" charset="UTF-8"></script> -::: +::::{card} Check your understanding +```{h5p} https://home.teachbooks.io/wp-admin/admin-ajax.php?action=h5p_embed&id=2 +``` +:::: -:::{card} Check your understanding -<iframe src="https://home.teachbooks.io/wp-admin/admin-ajax.php?action=h5p_embed&id=1" width="959" height="502" frameborder="0" allowfullscreen="allowfullscreen" title="Testing more Teachbooks knowledge"></iframe> -::: \ No newline at end of file +::::{card} Check your understanding +```{h5p} https://home.teachbooks.io/wp-admin/admin-ajax.php?action=h5p_embed&id=1 +``` +:::: diff --git a/requirements.txt b/requirements.txt index 4d6bb6c..3c3ee06 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,7 +5,7 @@ sphinx-image-inverter download_link_replacer sphinx-exercise teachbooks-sphinx-tippy +sphinx-iframes -# 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/11239/packages/pypi/simple -sphinx-thebe ~= 0.9.9 +# Now list the packages you want to download directly from GitHub +git+https://github.com/TeachBooks/Sphinx-Thebe