From 4f814bea7e3a0f372b318aba2aae8b836350d32e Mon Sep 17 00:00:00 2001 From: Dennis den Ouden-van der Horst Date: Fri, 2 May 2025 08:18:02 +0200 Subject: [PATCH 1/2] Force update --- book/_git/cloned_repos.txt | 2 + book/_toc_with_local_paths.yml | 130 ++++++++++++++++++ book/references.bib | 235 +++++++++++++++++---------------- 3 files changed, 250 insertions(+), 117 deletions(-) create mode 100644 book/_git/cloned_repos.txt create mode 100644 book/_toc_with_local_paths.yml diff --git a/book/_git/cloned_repos.txt b/book/_git/cloned_repos.txt new file mode 100644 index 0000000..1b24cb4 --- /dev/null +++ b/book/_git/cloned_repos.txt @@ -0,0 +1,2 @@ +C:\Users\douden\Documents\GitHub\manual\book\_git/github.com_TeachBooks_Sphinx-Indexed-Definitions/manual +C:\Users\douden\Documents\GitHub\manual\book\_git/github.com_TeachBooks_Sphinx-ref-graph/manual diff --git a/book/_toc_with_local_paths.yml b/book/_toc_with_local_paths.yml new file mode 100644 index 0000000..cdc4924 --- /dev/null +++ b/book/_toc_with_local_paths.yml @@ -0,0 +1,130 @@ +# ToC file with localized paths. Used for Teachbooks' external content feature. +format: jb-book +parts: +- caption: Your First TeachBook! + chapters: + - file: intro/book.md + - file: intro/workflow.md + - file: intro/template.md + - file: intro/next.md +- caption: Getting Going! + chapters: + - file: installation-and-setup/user_types.md + - file: installation-and-setup/git.md + sections: + - file: installation-and-setup/tools + - file: installation-and-setup/overview.md + sections: + - file: installation-and-setup/vscode-setup.md + - file: installation-and-setup/git-setup_local.md + - file: installation-and-setup/anaconda.md + - file: installation-and-setup/git_bash_conda_vs-code.md + - file: installation-and-setup/jupyter-book-setup.md + - file: workflows/collaboration.md + sections: + - file: workflows/milestones_issues.md + - file: workflows/branches.md + - file: workflows/edit_book.md + - file: workflows/check_changes_online.md + - file: workflows/merge_request.md + - file: installation-and-setup/collab + - file: installation-and-setup/versioning + sections: + - file: installation-and-setup/versions_URLs + - file: installation-and-setup/versioning_changelog + - file: installation-and-setup/publisher + - file: installation-and-setup/copyright.md + sections: + - file: installation-and-setup/copyright/considerations + - file: installation-and-setup/copyright/licenses + - file: installation-and-setup/copyright/recommendations +- caption: Features + chapters: + - file: features/overview.md + - file: basic-features/overview.md + sections: + - file: basic-features/jupyterbook.md + - file: basic-features/figures.md + - file: basic-features/equations.md + - file: basic-features/videos.md + - file: basic-features/References.md + - file: basic-features/code.md + - file: basic-features/Code_block_figures + - file: basic-features/badges.md + - file: basic-features/banner + title: Banner or Announcement + - file: features/easy-editing.md + sections: + - file: external/template/README.md + - file: features/draft-release + - file: external/deploy-book-workflow/README.md + - file: features/pull_request_build.md + - file: features/local_server + - file: features/external_toc + sections: + - file: external/Nested-Books/README.md + title: (Deprecated) Share content between books using submodules + - file: features/update_env + - file: features/versioning + - file: features/sphinx_extensions.md + sections: + - file: external/Download-Link-Replacer/README.md + - file: external/Sphinx-launch-buttons/README.md + - file: basic-features/utterances.md + - file: features/h5p.md + sections: + - file: examples/h5p_examples.md + - file: features/plotly.ipynb + - file: external/Sphinx-Grasple-public/README.md + - file: features/HTML_javascript.md + sections: + - file: features/adding_HTML_elements.md + - file: features/creating_basic_HTML_elements.md + - file: features/live_code + sections: + - file: features/widgets.ipynb + - file: features/exercise_checking.ipynb + - file: features/jupyterquiz.ipynb + - file: external/sphinx-iframes/README.md + - file: _git/github.com_TeachBooks_Sphinx-Indexed-Definitions/manual/README.md + - file: external/Sphinx-PRIME-applets/README.md + - file: features/visuals.md + sections: + - file: external/Sphinx-Image-Inverter/README.md + - file: external/JupyterBook-Patches/README.md + - file: external/Sphinx-TUDelft-theme/README.md + - file: external/teachbooks-sphinx-tippy/README.md + - file: features/apa + - file: external/Sphinx-Named-Colors/README.md + - file: _git/github.com_TeachBooks_Sphinx-ref-graph/manual/README.md + - file: features/students + sections: + - file: external/annotater/README.md + - file: basic-features/hypothesis.md +- caption: Examples + chapters: + - file: examples/overview.md + - file: examples/book_structure.md + - file: examples/live_code.md + - file: examples/example_gumbel.ipynb + - file: examples/theory_questions.md + - file: examples/example_quiz_interactive.ipynb + - file: examples/coding_theory_widgets.ipynb + - file: examples/parametric_questions.ipynb +- caption: Editing Tools + chapters: + - file: tools/figmaker + - file: helper_code/intro.md + sections: + - file: helper_code/converter.md + - file: helper_code/move_images.md + - file: external/Useful_python_code/snippit.ipynb + - file: external/Useful_python_code/extensionfildownloadreturn.ipynb + - file: external/Useful_python_code/figshrinker.ipynb +- caption: Miscallaneous + chapters: + - file: references.md + - file: credits + - file: changelog + - file: contact +root: intro diff --git a/book/references.bib b/book/references.bib index 7b3d706..61219ae 100644 --- a/book/references.bib +++ b/book/references.bib @@ -1,184 +1,185 @@ @misc{timon_latex, - title={LaTeX to Markdown conversion}, - author={Idema (Delft University of Technology), Timon}, - institution ={Delft University of Technology}, - url={https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}, - year={2024}, - note = {Retrieved December, 2024. BSD-3.} + title = {LaTeX to Markdown conversion}, + author = {Idema (Delft University of Technology), Timon}, + institution = {Delft University of Technology}, + url = {https://gitlab.tudelft.nl/opentextbooks/latex-to-markdown-conversion}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3.}, } @misc{hall21, - author = {Hall, Matt}, - title = {Which open licence should I choose?}, - institution = {Agile Scientific}, - url = {https://agilescientific.com/blog/2021/2/17/which-open-licence-should-i-choose}, - year = {2021}, - note = {Online; posted 17-February-2021. CC BY.} + author = {Hall, Matt}, + title = {Which open licence should I choose?}, + institution = {Agile Scientific}, + url = {https://agilescientific.com/blog/2021/2/17/which-open-licence-should-i-choose}, + year = {2021}, + note = {Online; posted 17-February-2021. CC BY.}, } @misc{jason_moore, - title={Learn Multibody Dynamics, SymPy}, - author={Moore, Jason}, - url={https://moorepants.github.io/learn-multibody-dynamics/sympy.html}, - year={2023} + title = {Learn Multibody Dynamics, SymPy}, + author = {Moore, Jason}, + url = {https://moorepants.github.io/learn-multibody-dynamics/sympy.html}, + year = {2023}, } @misc{tud_cip_24, - author = {{TU Delft Library}}, - title = {Copyright Information Point}, - url = {https://www.tudelft.nl/library/support/copyright}, - year = {2024}, - note = {Retrieved December, 2024. CC BY 4.0.} + author = {{TU Delft Library}}, + title = {Copyright Information Point}, + url = {https://www.tudelft.nl/library/support/copyright}, + year = {2024}, + note = {Retrieved December, 2024. CC BY 4.0.}, } @misc{deploy_book, - author = {{TeachBooks}}, - title = {GitHub reusable action: publish your book online to GitHub Pages}, - url = {https://github.com/TeachBooks/deploy-book-workflow}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {GitHub reusable action: publish your book online to GitHub Pages}, + url = {https://github.com/TeachBooks/deploy-book-workflow}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{download_link, - author = {{TeachBooks}}, - title = {Sphinx extension: download link replacer}, - url = {https://github.com/TeachBooks/Download-Link-Replacer}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {Sphinx extension: download link replacer}, + url = {https://github.com/TeachBooks/Download-Link-Replacer}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{patches, - author = {{TeachBooks}}, - title = {Sphinx extension: JupyterBook-Patches}, - url = {https://github.com/TeachBooks/JupyterBook-Patches}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {Sphinx extension: JupyterBook-Patches}, + url = {https://github.com/TeachBooks/JupyterBook-Patches}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{annotator, - author = {{TeachBooks}}, - title = {Local Annotator Extension}, - url = {https://github.com/TeachBooks/annotator}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {Local Annotator Extension}, + url = {https://github.com/TeachBooks/annotator}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{nested, - author = {{TeachBooks}}, - title = {Git workflow: Share content between book}, - url = {https://github.com/TeachBooks/Nested-Books}, - year = {2024}, - note = {Retrieved December, 2024. CC BY 4.0.} + author = {{TeachBooks}}, + title = {Git workflow: Share content between book}, + url = {https://github.com/TeachBooks/Nested-Books}, + year = {2024}, + note = {Retrieved December, 2024. CC BY 4.0.}, } @misc{grasple, - author = {{TeachBooks}}, - title = {Sphinx extension: Grasple}, - url = {https://github.com/TeachBooks/Sphinx-Grasple-public}, - year = {2024}, - note = {Retrieved December, 2024. MIT.} + author = {{TeachBooks}}, + title = {Sphinx extension: Grasple}, + url = {https://github.com/TeachBooks/Sphinx-Grasple-public}, + year = {2024}, + note = {Retrieved December, 2024. MIT.}, } @misc{image, - author = {{TeachBooks}}, - title = {Sphinx extension: Image Inverter}, - url = {https://github.com/TeachBooks/Sphinx-Image-Inverter}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {Sphinx extension: Image Inverter}, + url = {https://github.com/TeachBooks/Sphinx-Image-Inverter}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{tudelft_theme, - author = {{TeachBooks}}, - title = {Sphinx extension: TU Delft theme}, - url = {https://github.com/TeachBooks/Sphinx-TUDelft-theme}, - year = {2024}, - note = {Retrieved December, 2024. MIT.} + author = {{TeachBooks}}, + title = {Sphinx extension: TU Delft theme}, + url = {https://github.com/TeachBooks/Sphinx-TUDelft-theme}, + year = {2024}, + note = {Retrieved December, 2024. MIT.}, } @misc{tippy, - author = {{TeachBooks}}, - title = {TeachBooks Sphinx extension: Rich hover over tips}, - url = {https://github.com/TeachBooks/teachbooks-sphinx-tippy}, - year = {2024}, - note = {Retrieved December, 2024. MIT.} + author = {{TeachBooks}}, + title = {TeachBooks Sphinx extension: Rich hover over tips}, + url = {https://github.com/TeachBooks/teachbooks-sphinx-tippy}, + year = {2024}, + note = {Retrieved December, 2024. MIT.}, } @misc{template, - author = {{TeachBooks}}, - title = {Your first TeachBook using the GitHub template}, - url = {https://github.com/TeachBooks/template}, - year = {2024}, - note = {Retrieved December, 2024. CC BY 4.0.} + author = {{TeachBooks}}, + title = {Your first TeachBook using the GitHub template}, + url = {https://github.com/TeachBooks/template}, + year = {2024}, + note = {Retrieved December, 2024. CC BY 4.0.}, } @misc{useful_code, - author = {{TeachBooks}}, - title = {Useful python code}, - url = {https://github.com/TeachBooks/Useful_python_code}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {Useful python code}, + url = {https://github.com/TeachBooks/Useful_python_code}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{launch_buttons, - author = {{TeachBooks}}, - title = {Custom launch buttons}, - url = {https://github.com/TeachBooks/Sphinx-launch-buttons}, - year = {2024}, - note = {Retrieved December, 2024. BSD-3-Clause.} + author = {{TeachBooks}}, + title = {Custom launch buttons}, + url = {https://github.com/TeachBooks/Sphinx-launch-buttons}, + year = {2024}, + note = {Retrieved December, 2024. BSD-3-Clause.}, } @misc{sphinx-colors, - author = {{TeachBooks}}, - title = {Sphinx Named Colors}, - url = {https://github.com/TeachBooks/Sphinx-Named-Colors}, - year = {2024}, - note = {Retrieved January 2025. MIT.} + author = {{TeachBooks}}, + title = {Sphinx Named Colors}, + url = {https://github.com/TeachBooks/Sphinx-Named-Colors}, + year = {2024}, + note = {Retrieved January 2025. MIT.}, } @misc{semver, - author = {Tom Preston-Werner}, - title = {Semantic Versioning specification}, - url = {https://semver.org/}, - year = {2025}, - note = {Retrieved February 2025. CC BY 3.0.} + author = {Tom Preston-Werner}, + title = {Semantic Versioning specification}, + url = {https://semver.org/}, + year = {2025}, + note = {Retrieved February 2025. CC BY 3.0.}, } @misc{sphinx-iframes, - author = {{TeachBooks}}, - title = {Sphinx iframes}, - url = {https://github.com/TeachBooks/sphinx-iframes}, - year = {2025}, - note = {Retrieved April 2025. MIT.} + author = {{TeachBooks}}, + title = {Sphinx iframes}, + url = {https://github.com/TeachBooks/sphinx-iframes}, + year = {2025}, + note = {Retrieved April 2025. MIT.}, } @misc{sphinx-prime-applets, - author = {{TeachBooks}}, - title = {Sphinx PRIME applets}, - url = {https://github.com/TeachBooks/Sphinx-PRIME-applets}, - year = {2025}, - note = {Retrieved April 2025. MIT.} + author = {{TeachBooks}}, + title = {Sphinx PRIME applets}, + url = {https://github.com/TeachBooks/Sphinx-PRIME-applets}, + year = {2025}, + note = {Retrieved April 2025. MIT.}, } @misc{teachbooks_package, - author = {{TeachBooks}}, - title = {TeachBooks Package: Jupyter Book Wrapper}, - url = {https://github.com/TeachBooks/TeachBooks}, - year = {2024}, - note = {Retrieved April, 2025. MIT License.} + author = {{TeachBooks}}, + 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.} + author = {{TeachBooks}}, + title = {Sphinx Indexed Definitions}, + url = {https://github.com/TeachBooks/Sphinx-Indexed-Definitions}, + year = {2025}, + note = {Retrieved April, 2025. MIT License.}, } @misc{sphinx-interactive-graph, - 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 + author = {{TeachBooks}}, + title = {Sphinx Indexed Definitions}, + url = {https://github.com/TeachBooks/Sphinx-Indexed-Definitions}, + year = {2025}, + note = {Retrieved April, 2025. MIT License.}, +} + From 72e394a10401db84f725104f806b10184c594a61 Mon Sep 17 00:00:00 2001 From: Dennis den Ouden-van der Horst Date: Fri, 2 May 2025 08:25:11 +0200 Subject: [PATCH 2/2] Oops --- book/_git/cloned_repos.txt | 2 - book/_toc_with_local_paths.yml | 130 --------------------------------- 2 files changed, 132 deletions(-) delete mode 100644 book/_git/cloned_repos.txt delete mode 100644 book/_toc_with_local_paths.yml diff --git a/book/_git/cloned_repos.txt b/book/_git/cloned_repos.txt deleted file mode 100644 index 1b24cb4..0000000 --- a/book/_git/cloned_repos.txt +++ /dev/null @@ -1,2 +0,0 @@ -C:\Users\douden\Documents\GitHub\manual\book\_git/github.com_TeachBooks_Sphinx-Indexed-Definitions/manual -C:\Users\douden\Documents\GitHub\manual\book\_git/github.com_TeachBooks_Sphinx-ref-graph/manual diff --git a/book/_toc_with_local_paths.yml b/book/_toc_with_local_paths.yml deleted file mode 100644 index cdc4924..0000000 --- a/book/_toc_with_local_paths.yml +++ /dev/null @@ -1,130 +0,0 @@ -# ToC file with localized paths. Used for Teachbooks' external content feature. -format: jb-book -parts: -- caption: Your First TeachBook! - chapters: - - file: intro/book.md - - file: intro/workflow.md - - file: intro/template.md - - file: intro/next.md -- caption: Getting Going! - chapters: - - file: installation-and-setup/user_types.md - - file: installation-and-setup/git.md - sections: - - file: installation-and-setup/tools - - file: installation-and-setup/overview.md - sections: - - file: installation-and-setup/vscode-setup.md - - file: installation-and-setup/git-setup_local.md - - file: installation-and-setup/anaconda.md - - file: installation-and-setup/git_bash_conda_vs-code.md - - file: installation-and-setup/jupyter-book-setup.md - - file: workflows/collaboration.md - sections: - - file: workflows/milestones_issues.md - - file: workflows/branches.md - - file: workflows/edit_book.md - - file: workflows/check_changes_online.md - - file: workflows/merge_request.md - - file: installation-and-setup/collab - - file: installation-and-setup/versioning - sections: - - file: installation-and-setup/versions_URLs - - file: installation-and-setup/versioning_changelog - - file: installation-and-setup/publisher - - file: installation-and-setup/copyright.md - sections: - - file: installation-and-setup/copyright/considerations - - file: installation-and-setup/copyright/licenses - - file: installation-and-setup/copyright/recommendations -- caption: Features - chapters: - - file: features/overview.md - - file: basic-features/overview.md - sections: - - file: basic-features/jupyterbook.md - - file: basic-features/figures.md - - file: basic-features/equations.md - - file: basic-features/videos.md - - file: basic-features/References.md - - file: basic-features/code.md - - file: basic-features/Code_block_figures - - file: basic-features/badges.md - - file: basic-features/banner - title: Banner or Announcement - - file: features/easy-editing.md - sections: - - file: external/template/README.md - - file: features/draft-release - - file: external/deploy-book-workflow/README.md - - file: features/pull_request_build.md - - file: features/local_server - - file: features/external_toc - sections: - - file: external/Nested-Books/README.md - title: (Deprecated) Share content between books using submodules - - file: features/update_env - - file: features/versioning - - file: features/sphinx_extensions.md - sections: - - file: external/Download-Link-Replacer/README.md - - file: external/Sphinx-launch-buttons/README.md - - file: basic-features/utterances.md - - file: features/h5p.md - sections: - - file: examples/h5p_examples.md - - file: features/plotly.ipynb - - file: external/Sphinx-Grasple-public/README.md - - file: features/HTML_javascript.md - sections: - - file: features/adding_HTML_elements.md - - file: features/creating_basic_HTML_elements.md - - file: features/live_code - sections: - - file: features/widgets.ipynb - - file: features/exercise_checking.ipynb - - file: features/jupyterquiz.ipynb - - file: external/sphinx-iframes/README.md - - file: _git/github.com_TeachBooks_Sphinx-Indexed-Definitions/manual/README.md - - file: external/Sphinx-PRIME-applets/README.md - - file: features/visuals.md - sections: - - file: external/Sphinx-Image-Inverter/README.md - - file: external/JupyterBook-Patches/README.md - - file: external/Sphinx-TUDelft-theme/README.md - - file: external/teachbooks-sphinx-tippy/README.md - - file: features/apa - - file: external/Sphinx-Named-Colors/README.md - - file: _git/github.com_TeachBooks_Sphinx-ref-graph/manual/README.md - - file: features/students - sections: - - file: external/annotater/README.md - - file: basic-features/hypothesis.md -- caption: Examples - chapters: - - file: examples/overview.md - - file: examples/book_structure.md - - file: examples/live_code.md - - file: examples/example_gumbel.ipynb - - file: examples/theory_questions.md - - file: examples/example_quiz_interactive.ipynb - - file: examples/coding_theory_widgets.ipynb - - file: examples/parametric_questions.ipynb -- caption: Editing Tools - chapters: - - file: tools/figmaker - - file: helper_code/intro.md - sections: - - file: helper_code/converter.md - - file: helper_code/move_images.md - - file: external/Useful_python_code/snippit.ipynb - - file: external/Useful_python_code/extensionfildownloadreturn.ipynb - - file: external/Useful_python_code/figshrinker.ipynb -- caption: Miscallaneous - chapters: - - file: references.md - - file: credits - - file: changelog - - file: contact -root: intro