diff --git a/.gitignore b/.gitignore index 1d59fdc..bb960ab 100644 --- a/.gitignore +++ b/.gitignore @@ -137,4 +137,6 @@ _output/ book/.jupyterlite.doit.db # TeachBooks -**.teachbooks/ \ No newline at end of file +**.teachbooks/ +book/_toc_with_local_paths.yml +book/_git/ \ No newline at end of file diff --git a/book/_toc.yml b/book/_toc.yml index 5fa8b99..daee2b3 100644 --- a/book/_toc.yml +++ b/book/_toc.yml @@ -97,6 +97,7 @@ parts: - file: external/teachbooks-sphinx-tippy/README.md - file: features/apa - file: external/Sphinx-Named-Colors/README.md + - external: https://github.com/TeachBooks/Sphinx-ref-graph/blob/manual/README.md - file: features/students sections: - file: external/annotater/README.md diff --git a/book/credits.md b/book/credits.md index 5cf5abe..492180c 100644 --- a/book/credits.md +++ b/book/credits.md @@ -57,6 +57,7 @@ The following pages are included directly from an external resource and is not e - 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. +- Page [](interactive_graph_content). 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/references.bib b/book/references.bib index 65a4761..61219ae 100644 --- a/book/references.bib +++ b/book/references.bib @@ -1,176 +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.} -} \ 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.}, +} + +@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.}, +} +