diff --git a/book/_config.yml b/book/_config.yml index eaa1a16..8e790c7 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,5 +1,5 @@ title: TeachBooks Manual -author: TeachBooks Team, built with TeachBooks and Jupyter Book, CC BY 4.0 +author: TeachBooks Development Team and TeachBooks users, built with TeachBooks and Jupyter Book, CC BY 4.0 execute: execute_notebooks: 'off' diff --git a/book/_toc.yml b/book/_toc.yml index d6badc4..5fa8b99 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -87,6 +87,7 @@ parts: - file: features/exercise_checking.ipynb - file: features/jupyterquiz.ipynb - file: external/sphinx-iframes/README.md + - external: https://github.com/TeachBooks/Sphinx-Indexed-Definitions/blob/manual/README.md - file: external/Sphinx-PRIME-applets/README.md - file: features/visuals.md sections: diff --git a/book/basic-features/jupyterbook.md b/book/basic-features/jupyterbook.md index 6737a17..22dc777 100644 --- a/book/basic-features/jupyterbook.md +++ b/book/basic-features/jupyterbook.md @@ -116,6 +116,9 @@ parts: - file: section_1_2 ``` +#### Exercise +Check out [this exercise](https://teachbooks.io/template/syntax_exercises/007.html) in the TeachBooks template to see for yourself how to structure files with titles! + ### Including a chapter twice In some cases you want to include the same chapter in two different places in your book (for instance parts). However, you do not want to make the same adjustments in different files, the content should only 'live' in one place. The solution is to use `include`: diff --git a/book/credits.md b/book/credits.md index 7e00316..696171d 100644 --- a/book/credits.md +++ b/book/credits.md @@ -56,6 +56,7 @@ The following pages are included directly from an external resource and is not e - Page [](./external/teachbooks-sphinx-tippy/README.md). Original content licensed under MIT license. - Page [](./external/template/README.md). Original content licensed under CC BY 4.0 license. - Page [](./external/Sphinx-Named-Colors/README.md). Original content licensed under MIT license. +- Page [](indexed_defintions). Original content licensed under MIT license. - Pages [](./external/Useful_python_code/extensionfildownloadreturn.ipynb), [](./external/Useful_python_code/figshrinker.ipynb) and [](./external/Useful_python_code/snippit.ipynb). Original content licensed under BSD 3-Clause license. The following pages contain content written by others, part of has been reused and/or modified by the TeachBooks Team: diff --git a/book/external/Sphinx-Named-Colors b/book/external/Sphinx-Named-Colors index b4b1a2e..57ecdd8 160000 --- a/book/external/Sphinx-Named-Colors +++ b/book/external/Sphinx-Named-Colors @@ -1 +1 @@ -Subproject commit b4b1a2e5d087336108bc15b176af1999b61dc86a +Subproject commit 57ecdd887e8bbc32a04aca20e9fc9cb60409b7d0 diff --git a/book/external/Sphinx-TUDelft-theme b/book/external/Sphinx-TUDelft-theme index d845f78..2ab5d1d 160000 --- a/book/external/Sphinx-TUDelft-theme +++ b/book/external/Sphinx-TUDelft-theme @@ -1 +1 @@ -Subproject commit d845f78e04bc0a4feca0c917f88599bdd1f02ecb +Subproject commit 2ab5d1d708aed595b9630c94081e05c11a84b18c diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index 910542a..427215f 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit 910542a3ac426020f738dfb0de313f66d9d3f43f +Subproject commit 427215f1ccc048847abd8cd86a1ba2e85c2dd549 diff --git a/book/external/sphinx-iframes b/book/external/sphinx-iframes index 062c54a..e21273d 160000 --- a/book/external/sphinx-iframes +++ b/book/external/sphinx-iframes @@ -1 +1 @@ -Subproject commit 062c54a679c6dd44b948549498e755c7c5df1d73 +Subproject commit e21273da134cbf4753da5faf9adc277b8f1c3a1c diff --git a/book/references.bib b/book/references.bib index ed12b0f..65a4761 100644 --- a/book/references.bib +++ b/book/references.bib @@ -161,8 +161,16 @@ @misc{teachbooks_package, author = {{TeachBooks}}, - title = {TeachBooks Package: Jupyter Book Wrappe}, + title = {TeachBooks Package: Jupyter Book Wrapper}, url = {https://github.com/TeachBooks/TeachBooks}, year = {2024}, note = {Retrieved April, 2025. MIT License.} +} + +@misc{sphinx-indexed-definitions, + author = {{TeachBooks}}, + title = {Sphinx Indexed Definitions}, + url = {https://github.com/TeachBooks/Sphinx-Indexed-Definitions}, + year = {2025}, + note = {Retrieved April, 2025. MIT License.} } \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index 7edb00d..30d3abd 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -teachbooks == 0.1.0 +teachbooks == 0.2.0 sphinx-inline-tabs == 2023.4.21 jupyterbook_patches==1.4.4 download_link_replacer == 1.0.4 @@ -12,4 +12,4 @@ sphinx-prime-applets == 1.0.2 git+https://github.com/TeachBooks/Sphinx-Thebe -docutils==0.17.1 \ No newline at end of file +docutils==0.17.1