admin2/template
1
0
Fork 0
mirror of https://github.com/TeachBooks/template.git synced 2026-11-12 22:25:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' into manual_description

Browse source
This commit is contained in:
Tom van Woudenberg 2024-11-11 12:58:37 +01:00
commit 3ebf1d05dc
8 changed files with 33 additions and 84 deletions
Download patch file Download diff file Expand all files Collapse all files

4
book/_config.yml
View file

@ -1,6 +1,6 @@
title: Template
author: TeachBooks Team from Delft University of Technology, built with <a href="https://teachbooks.tudelft.nl/">TeachBooks</a> and <a href="https://jupyterbook.org/">Jupyter Book</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a> #add your own name here
logo: figures/TUDelft_logo_rgb.svg #add your own logo here
logo: figures/TB_logo.png #add your own logo here
execute:
execute_notebooks: "off"
@ -8,7 +8,7 @@ execute:
only_build_toc_files: true
html:
favicon : "figures/favicon.ico"
favicon : "figures/TB_favicon.ico"
baseurl : "https://teachbooks.github.io/template/" #Replace this with your own URL
sphinx:

2
book/_toc.yml
View file

@ -8,3 +8,5 @@ parts:
sections:
- file: some_content/text_and_code.ipynb
- file: references.md
- file: changelog.md
- file: credits.md

4
book/changelog.md Normal file
View file

@ -0,0 +1,4 @@
# Changelog
## `<date>` [`<release name>`](<`link to release on GitHub>`)
- `<Added/modified/deleted>` [](`<relative link to changed file>`)

25
book/credits.md Normal file
View file

@ -0,0 +1,25 @@
(credits)=
# Credits and License
You can refer to this book as:
> `<editors>` (`<year>`) _`<title>`_. `<url to github repo>`
The introduction, structure of the book and formatting of contents is done by the Editors. Some chapters and pages have additional primary authors who are identified within the book either at the bottom of the first page in a chapter, or at the bottom of an individual page, as necessary. If an author is not listed on a particular page, it is by the Editors.
You can refer to individual chapters or pages within this book as:
> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>`
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 within the book. For example:
> `<Primary Author>` (`<date>`) `<Title of Chapter or Page>`. In `<editors>` (Ed.), _`<title>`_. `<url to github repo>` (`./book/intro/` chapter, accessed November, 2024).
## How the book is made
This book is created using open source tools: it is a Jupyter Book that is written using Markdown, Jupyter notebooks and Python files to generate some figures. The files are stored on a [public GitHub repository](`<link to GitHub repo>`). The website can be viewed at `<link to book website url>`. View the repository README file or contact the authors for additional information.
(editor)=
## About the Editors
### Acknowledgements

BIN
book/figures/TB_favicon.ico Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 105 KiB

BIN
book/figures/TB_logo.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 544 KiB

82
book/figures/TUDelft_logo_rgb.svg
View file

@ -1,82 +0,0 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<!-- Gegenereerd door Microsoft Visio, SVG Export TUDelft_logo_rgb.svg Pagina-1 -->
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ev="http://www.w3.org/2001/xml-events"
xmlns:v="http://schemas.microsoft.com/visio/2003/SVGExtensions/" width="2.35212in" height="1.45512in"
viewBox="0 0 169.353 104.769" xml:space="preserve" color-interpolation-filters="sRGB" class="st4">
<v:documentProperties v:langID="1043" v:metric="true" v:viewMarkup="false"/>
<style type="text/css">
<![CDATA[
.st1 {fill:none;stroke:none;stroke-linecap:butt;stroke-width:0.726936}
.st2 {fill:#00a6d6;stroke:none;stroke-linecap:butt;stroke-width:0.726936}
.st3 {fill:#000000;stroke:none;stroke-linecap:butt;stroke-width:0.726936}
.st4 {fill:none;fill-rule:evenodd;font-size:12px;overflow:visible;stroke-linecap:square;stroke-miterlimit:3}
]]>
</style>
<g v:mID="0" v:index="1" v:groupContext="foregroundPage">
<title>Pagina-1</title>
<v:pageProperties v:drawingScale="1" v:pageScale="1" v:drawingUnits="19" v:shadowOffsetX="9" v:shadowOffsetY="-9"/>
<g id="group1-1" transform="translate(0.726936,-0.726936)" v:mID="1" v:groupContext="group">
<title>Blad.1</title>
<g id="shape2-2" v:mID="2" v:groupContext="shape">
<title>Blad.2</title>
<rect x="0" y="1.45387" width="167.899" height="103.315" class="st1"/>
</g>
<g id="shape3-4" v:mID="3" v:groupContext="shape" transform="translate(39.4603,-38.2048)">
<title>Blad.3</title>
<path d="M12.35 99.76 C15.71 99.76 17.55 97.52 17.55 94.39 L17.55 78.4 L24.7 78.4 L24.7 94.75 C24.64 101.95 18.87
104.77 12.35 104.77 C5.83 104.77 0.08 101.95 0 94.75 L0 78.4 L7.15 78.4 L7.15 94.39 C7.17 97.52 8.99
99.76 12.35 99.76 Z" class="st2"/>
</g>
<g id="shape4-6" v:mID="4" v:groupContext="shape" transform="translate(12.9059,-38.7448)">
<title>Blad.4</title>
<path d="M8.02 104.77 L15.17 104.77 L15.17 83.95 L23.19 83.95 L23.19 78.94 L0 78.94 L0 83.95 L8.02 83.95 L8.02 104.77
Z" class="st3"/>
</g>
<g id="shape5-8" v:mID="5" v:groupContext="shape" transform="translate(18.1979,-66.1767)">
<title>Blad.5</title>
<path d="M19.93 93.79 C18.18 94.35 16.38 93.9 16.39 91.57 C16.39 88 24.75 85.02 25.91 81.91 C26.19 81.14 26.22 80.5
25.84 80.52 C25.57 80.54 25.78 80.93 25.19 81.51 C21.73 84.98 15.93 84.96 11.47 86.96 C8.56 88.27 0
92.29 1.97 101.27 C2.07 101.7 2.32 103.12 2.58 103.12 C2.88 103.12 2.88 102.27 2.88 101.25 C2.81 95.9
9.14 94.41 11.2 90.92 C11.45 90.5 11.88 89.92 11.97 90.19 C12.03 90.32 11.99 90.51 11.91 90.89 C11.26
93.77 8.26 95.6 9.11 97.65 C10.22 100.31 13.39 98.33 14.38 96.61 C14.63 96.14 14.78 95.85 14.96 95.9
C15.09 95.94 15.08 96.48 15 96.97 C14.47 100.06 13.77 101.79 11.5 103.55 C10.77 104.12 9.64 104.23 9.79
104.66 C9.83 104.77 10.31 104.76 10.71 104.71 C16.73 104.32 21.76 97.24 23.1 92.59 C23.23 92.27 23.27
91.96 23.14 91.85 C22.96 91.71 22.69 92.02 22.42 92.27 C21.73 92.89 20.79 93.52 19.93 93.79 Z"
class="st3"/>
</g>
<g id="shape6-10" v:mID="6" v:groupContext="shape" transform="translate(95.6875,-38.1913)">
<title>Blad.6</title>
<path d="M3.54 93.52 C3.56 90.72 5.25 88.19 8.09 88.19 C11.38 88.19 12.66 90.45 12.66 93.52 L3.54 93.52 ZM16.25 95.89
L16.25 94.2 C16.25 89.23 13.43 85.72 8.34 85.72 C2.66 85.72 0 90.12 0 95.39 C0 100.68 2.29 104.77 8.06
104.77 C12.35 104.77 15.5 102.73 16.04 98.65 L12.46 98.65 C12.07 101.26 10.75 102.3 8.1 102.3 C4.63
102.3 3.47 99.21 3.47 95.9 L16.25 95.9 L16.25 95.89 Z" class="st3"/>
</g>
<g id="shape7-12" v:mID="7" v:groupContext="shape" transform="translate(116.059,-38.7448)">
<title>Blad.7</title>
<rect x="0" y="78.9435" width="3.40198" height="25.8254" class="st3"/>
</g>
<g id="shape8-14" v:mID="8" v:groupContext="shape" transform="translate(123.214,-38.7448)">
<title>Blad.8</title>
<path d="M6.91 104.77 L6.91 89.18 L11.06 89.18 L11.06 86.81 L6.91 86.81 L6.91 83.91 C6.91 81.83 7.91 81.48 9.84 81.48
C10.41 81.48 10.99 81.55 11.56 81.59 L11.56 78.77 C10.76 78.59 9.95 78.4 9.13 78.4 C5.91 78.4 3.51 80.02
3.51 83.45 L3.51 86.81 L0 86.81 L0 89.18 L3.51 89.18 L3.51 104.77 L6.91 104.77 Z" class="st3"/>
</g>
<g id="shape9-16" v:mID="9" v:groupContext="shape" transform="translate(136.214,-38.2048)">
<title>Blad.9</title>
<path d="M0 86.27 L0 88.64 L3.08 88.64 L3.08 100.08 C3.08 102.47 3.12 104.77 8.17 104.77 C8.95 104.77 9.69 104.7
10.49 104.55 L10.49 101.95 C9.94 102.08 9.23 102.16 8.69 102.16 C7.48 102.16 6.48 101.56 6.48 100.27
L6.48 88.65 L10.62 88.65 L10.62 86.29 L6.48 86.29 L6.48 81.39 L3.08 82.45 L3.08 86.29 L0 86.27 Z"
class="st3"/>
</g>
<g id="shape10-18" v:mID="10" v:groupContext="shape" transform="translate(71.3201,-38.7448)">
<title>Blad.10</title>
<path d="M0 104.77 L8.87 104.77 C19.91 104.77 21.07 95.41 21.07 91.85 C21.07 88.29 19.91 78.93 8.87 78.93 L0 78.93
L0 104.77 ZM3.58 82.02 L8.87 82.02 C14.84 82.02 17.32 86.53 17.32 91.86 C17.32 97.2 14.84 101.7 8.87
101.7 L3.58 101.7 L3.58 82.02 Z" class="st3"/>
</g>
</g>
</g>
</svg>
Side by side

Before

Width:  |  Height:  |  Size: 5.2 KiB

BIN
book/figures/favicon.ico
View file

Binary file not shown.
Side by side

Before

Width:  |  Height:  |  Size: 15 KiB