From d8eb2563de1de631bee1c0c36373aae2bae2bc36 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Tue, 17 Dec 2024 15:19:20 +0100 Subject: [PATCH] Added source for all readmes Closes #55 --- LICENSE | 67 ++++++++++++++++++-- book/credits.md | 12 +++- book/external/Download-Link-Replacer | 2 +- book/external/JupyterBook-Patches | 2 +- book/external/Nested-Books | 2 +- book/external/Sphinx-Grasple-public | 2 +- book/external/Sphinx-Image-Inverter | 2 +- book/external/Sphinx-TUDelft-theme | 2 +- book/external/Useful_python_code | 2 +- book/external/annotater | 2 +- book/external/deploy-book-workflow | 2 +- book/external/teachbooks-sphinx-tippy | 2 +- book/external/template | 2 +- book/references.bib | 88 +++++++++++++++++++++++++++ 14 files changed, 171 insertions(+), 18 deletions(-) diff --git a/LICENSE b/LICENSE index 4ea99c2..0131ab3 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ -Attribution 4.0 International +The license of this manual itself is CC BY 4.0. The same license is used for [](external/Nested-Books) and [](external/template). The license of other included materials are provided below.: -======================================================================= +Attribution 4.0 International Creative Commons Corporation ("Creative Commons") is not a law firm and does not provide legal services or legal advice. Distribution of @@ -52,8 +52,6 @@ exhaustive, and do not form part of our licenses. for the public: wiki.creativecommons.org/Considerations_for_licensees -======================================================================= - Creative Commons Attribution 4.0 International Public License By exercising the Licensed Rights (defined below), You accept and agree @@ -373,8 +371,6 @@ Section 8 -- Interpretation. processes of any jurisdiction or authority. -======================================================================= - Creative Commons is not a party to its public licenses. Notwithstanding, Creative Commons may elect to apply one of its public licenses to material it publishes and in those instances @@ -393,3 +389,62 @@ the avoidance of doubt, this paragraph does not form part of the public licenses. Creative Commons may be contacted at creativecommons.org. + +======================================================================= + +[](external/annotater), [](external/deploy-book-workflow), [](external/Download-Link-Replacer), [](external/JupyterBook-Patches), [](external/Sphinx-Image-Inverter) and [](external/Useful_python_code) are licensed under BSD 3-Clause license: + +BSD 3-Clause License + +Copyright (c) 2024, TeachBooks + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +3. Neither the name of the copyright holder nor the names of its + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE +FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR +SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER +CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, +OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +======================================================================= + +[](external/Sphinx-Grasple-public), [](external/Sphinx-TUDelft-theme) and [](external/teachbooks-sphinx-tippy) are licensed under MIT license: + +MIT License + +Copyright (c) 2024, TeachBooks + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/book/credits.md b/book/credits.md index 653ba8c..0846faf 100644 --- a/book/credits.md +++ b/book/credits.md @@ -41,7 +41,17 @@ Parts of this book are taken from other external resources and reused in various The following pages are included directly from an external resource and is not edited by the TeachBooks Team: -- _Work in progress: list the numerous README pages and include their respective licenses with the source code of this manual._ +- page [](./external/annotater/README.md). Original content licensed under BSD 3-Clause license. +- Page [](./external/deploy-book-workflow/README.md). Original content licensed under BSD 3-Clause license. +- Page [](./external/Download-Link-Replacer/README.md). Original content licensed under BSD 3-Clause license. +- Page [](./external/JupyterBook-Patches/README.md). Original content licensed under BSD 3-Clause license. +- Page [](./external/Nested-Books/README.md). Original content licensed under CC BY 4.0 license. +- Page [](./external/Sphinx-Grasple-public/README.md). Original content licensed under MIT license. +- Page [](./external/Sphinx-Image-Inverter/README.md). Original content licensed under BSD 3-Clause license. +- Page [](./external/Sphinx-TUDelft-theme/README.md). Original content licensed under MIT license. +- 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/Useful_python_code/README.md). 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: - Pages {ref}`copyright` and {ref}`copyright_considerations` include text from {cite:t}`tud_cip_24` that is used in the copyright checklist items. Original content licensed under CC BY. diff --git a/book/external/Download-Link-Replacer b/book/external/Download-Link-Replacer index 66952b5..f69e970 160000 --- a/book/external/Download-Link-Replacer +++ b/book/external/Download-Link-Replacer @@ -1 +1 @@ -Subproject commit 66952b5f23af2f0106eb24e56f186d729b5a1ca8 +Subproject commit f69e970a8da7d85e5473c7e5f58299a2ee3cf331 diff --git a/book/external/JupyterBook-Patches b/book/external/JupyterBook-Patches index edbfec1..f4d9638 160000 --- a/book/external/JupyterBook-Patches +++ b/book/external/JupyterBook-Patches @@ -1 +1 @@ -Subproject commit edbfec1142870af35032e18f301fcd9f9edc16e7 +Subproject commit f4d9638b197ad992d4e179295aa648b641925c6d diff --git a/book/external/Nested-Books b/book/external/Nested-Books index c2ebd1f..3cf6152 160000 --- a/book/external/Nested-Books +++ b/book/external/Nested-Books @@ -1 +1 @@ -Subproject commit c2ebd1fdad5abddb62d7f4c876f2f20d88d23f49 +Subproject commit 3cf61525f3985916805a59361935764d78e460df diff --git a/book/external/Sphinx-Grasple-public b/book/external/Sphinx-Grasple-public index c29b4a0..f4eff8d 160000 --- a/book/external/Sphinx-Grasple-public +++ b/book/external/Sphinx-Grasple-public @@ -1 +1 @@ -Subproject commit c29b4a03351c88fa5cdd09475f99a1b486a0e247 +Subproject commit f4eff8d1565eaf127898f2fe216cf5208684fb27 diff --git a/book/external/Sphinx-Image-Inverter b/book/external/Sphinx-Image-Inverter index c9c9d2f..c497add 160000 --- a/book/external/Sphinx-Image-Inverter +++ b/book/external/Sphinx-Image-Inverter @@ -1 +1 @@ -Subproject commit c9c9d2f6953b5a57ff4763976840ec3bb281dbcf +Subproject commit c497add7fea53bacdd24f1c7fa5ec7a850e5f9d0 diff --git a/book/external/Sphinx-TUDelft-theme b/book/external/Sphinx-TUDelft-theme index 8b86de6..7a52c03 160000 --- a/book/external/Sphinx-TUDelft-theme +++ b/book/external/Sphinx-TUDelft-theme @@ -1 +1 @@ -Subproject commit 8b86de655b4bc808f58cefbe65971d4e16453995 +Subproject commit 7a52c03dad4e50ec592041ee73e9a45558a68ee1 diff --git a/book/external/Useful_python_code b/book/external/Useful_python_code index e522976..be5911a 160000 --- a/book/external/Useful_python_code +++ b/book/external/Useful_python_code @@ -1 +1 @@ -Subproject commit e522976583a6c8cbc910531e972320a45f942737 +Subproject commit be5911ab42361663e7a021e0f303e79260cc7c4c diff --git a/book/external/annotater b/book/external/annotater index 7cd38db..0da75c3 160000 --- a/book/external/annotater +++ b/book/external/annotater @@ -1 +1 @@ -Subproject commit 7cd38dbba9ab50eebc5dbba6c61b9cb4f46d3cf0 +Subproject commit 0da75c3592d2ddafbcec61fc7248cfb0e3c8cc1b diff --git a/book/external/deploy-book-workflow b/book/external/deploy-book-workflow index f2feadf..ed2cdc8 160000 --- a/book/external/deploy-book-workflow +++ b/book/external/deploy-book-workflow @@ -1 +1 @@ -Subproject commit f2feadf1c39103311e98afdbda588f51d5e361c4 +Subproject commit ed2cdc81be5036deb8da244814a946d17ece7708 diff --git a/book/external/teachbooks-sphinx-tippy b/book/external/teachbooks-sphinx-tippy index 5aec30e..a80e764 160000 --- a/book/external/teachbooks-sphinx-tippy +++ b/book/external/teachbooks-sphinx-tippy @@ -1 +1 @@ -Subproject commit 5aec30ed8df7c6259faf7ac6cd178a0cf2887c17 +Subproject commit a80e7645bc5a377b3c75befdf29eb67934bb9ab7 diff --git a/book/external/template b/book/external/template index 4a5f1c8..337ba8f 160000 --- a/book/external/template +++ b/book/external/template @@ -1 +1 @@ -Subproject commit 4a5f1c8983241cc78d9fc91ba925d50402e9f558 +Subproject commit 337ba8f1dec89e7e29e9bad1520c5ee1302cf89e diff --git a/book/references.bib b/book/references.bib index 0b313c1..0b64ec8 100644 --- a/book/references.bib +++ b/book/references.bib @@ -29,4 +29,92 @@ howpublished = {\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}, + howpublished = {\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}, + howpublished = {\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}, + howpublished = {\url{https://github.com/TeachBooks/JupyterBook-Patches}}, + year = {2024}, + note = {Retrieved [December, 2024]. BSD-3-Clause.} +} + +@misc{annotator, + author = {{TeachBooks}}, + title = {Local Annotator Extension}, + howpublished = {\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}, + howpublished = {\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}, + howpublished = {\url{https://github.com/TeachBooks/Sphinx-Grasple-public}}, + year = {2024}, + note = {Retrieved [December, 2024]. MIT.} +} + +@misc{image, + author = {{TeachBooks}}, + title = {Sphinx extension: Image Inverter}, + howpublished = {\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}, + howpublished = {\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}, + howpublished = {\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}, + howpublished = {\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}, + howpublished = {\url{https://github.com/TeachBooks/Useful_python_code}}, + year = {2024}, + note = {Retrieved [December, 2024]. BSD-3-Clause.} } \ No newline at end of file