mirror of
https://github.com/TeachBooks/manual.git
synced 2026-11-12 22:35:51 +00:00
Merge branch 'release' into 51-add-sphinx-launch-button-as-submodule
This commit is contained in:
Tom van Woudenberg
GitHub
commit
40fb683f02
18 changed files with 243 additions and 11 deletions
13
.github/dependabot.yml
vendored
Normal file
13
.github/dependabot.yml
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# To get started with Dependabot version updates, you'll need to specify which
|
||||
# package ecosystems to update and where the package manifests are located.
|
||||
# Please see the documentation for all configuration options:
|
||||
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
|
||||
|
||||
version: 2
|
||||
updates:
|
||||
- package-ecosystem: "gitsubmodule" # See documentation for possible values
|
||||
directory: "/" # Location of package manifests
|
||||
schedule:
|
||||
interval: "weekly"
|
||||
day: "sunday"
|
||||
time: "22:59"
|
||||
1
.github/workflows/call-deploy-book.yml
vendored
1
.github/workflows/call-deploy-book.yml
vendored
|
|
@ -4,6 +4,7 @@ on:
|
|||
push:
|
||||
branches:
|
||||
- '**'
|
||||
# - '!dependabot**'
|
||||
# If your git repository has the Jupyter Book within some-subfolder next to
|
||||
# unrelated files, you can make this run only if a file within that specific
|
||||
# folder (or the workflow file itself) has been modified.
|
||||
|
|
|
|||
11
.gitmodules
vendored
11
.gitmodules
vendored
|
|
@ -1,36 +1,47 @@
|
|||
[submodule "book/external/Nested-Books"]
|
||||
path = book/external/Nested-Books
|
||||
url = https://github.com/TeachBooks/Nested-Books.git
|
||||
branch = manual-description
|
||||
[submodule "book/external/template"]
|
||||
path = book/external/template
|
||||
url = https://github.com/TeachBooks/template.git
|
||||
branch = manual_description
|
||||
[submodule "book/external/deploy-book-workflow"]
|
||||
path = book/external/deploy-book-workflow
|
||||
url = https://github.com/TeachBooks/deploy-book-workflow.git
|
||||
branch = manual_docs
|
||||
[submodule "book/external/Useful_python_code"]
|
||||
path = book/external/Useful_python_code
|
||||
url = https://github.com/TeachBooks/Useful_python_code.git
|
||||
branch = manual
|
||||
[submodule "book/external/Sphinx-Image-Inverter"]
|
||||
path = book/external/Sphinx-Image-Inverter
|
||||
url = https://github.com/TeachBooks/Sphinx-Image-Inverter.git
|
||||
branch = Manual
|
||||
[submodule "book/external/JupyterBook-Patches"]
|
||||
path = book/external/JupyterBook-Patches
|
||||
url = https://github.com/TeachBooks/JupyterBook-Patches.git
|
||||
branch = manual_docs
|
||||
[submodule "book/external/Download-Link-Replacer"]
|
||||
path = book/external/Download-Link-Replacer
|
||||
url = https://github.com/TeachBooks/Download-Link-Replacer.git
|
||||
branch = manual_docs
|
||||
[submodule "book/external/Sphinx-Grasple-public"]
|
||||
path = book/external/Sphinx-Grasple-public
|
||||
url = https://github.com/TeachBooks/Sphinx-Grasple-public.git
|
||||
branch = manual_docs
|
||||
[submodule "book/external/Sphinx-TUDelft-theme"]
|
||||
path = book/external/Sphinx-TUDelft-theme
|
||||
url = https://github.com/TeachBooks/Sphinx-TUDelft-theme.git
|
||||
branch = Manual
|
||||
[submodule "book/external/teachbooks-sphinx-tippy"]
|
||||
path = book/external/teachbooks-sphinx-tippy
|
||||
url = https://github.com/TeachBooks/teachbooks-sphinx-tippy.git
|
||||
branch = Manual
|
||||
[submodule "book/external/annotater"]
|
||||
path = book/external/annotater
|
||||
url = https://github.com/TeachBooks/annotater
|
||||
[submodule "book/external/Sphinx-launch-buttons"]
|
||||
path = book/external/Sphinx-launch-buttons
|
||||
url = https://github.com/TeachBooks/Sphinx-launch-buttons.git
|
||||
branch = manual
|
||||
|
|
|
|||
|
|
@ -16,6 +16,6 @@ This book will continue to develop, so feel free to contribute https://github.co
|
|||
|
||||
The released book can be found on on https://teachbooks.io/manual. This page shows the built book of the `release` branch All branches will also be visible as seen in the action's summaries: https://github.com/TeachBooks/mirror_teachbook_manual/actions
|
||||
|
||||
Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this boko including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git`
|
||||
Some parts of this book are taken from other sources in the form of submodules (linked in the folder [book/external](book/external)). To contribute to those pages, contribute to the source repository directly with a fork and merge/pull request. If you intent to clone this book including its submodules, clone using: `git clone --recurse-submodules git@github.com:TeachBooks/manual.git`
|
||||
|
||||
Happy book building!
|
||||
|
|
|
|||
|
|
@ -43,6 +43,10 @@ sphinx:
|
|||
html_static_path: ["images"]
|
||||
bibtex_default_style: myapastyle
|
||||
bibtex_reference_style: author_year_round
|
||||
mathjax3_config:
|
||||
tex:
|
||||
macros:
|
||||
"newcolor": ['\definecolor{newcolor}{RGB}{111, 29, 119}{\color{newcolor}#1}',1]
|
||||
local_extensions:
|
||||
apastyle: _ext/
|
||||
bracket_citation_style: _ext/
|
||||
|
|
|
|||
19
book/_static/color.css
Normal file
19
book/_static/color.css
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
:root {
|
||||
--newcolor-light: rgb(111, 29, 119);
|
||||
--newcolor-dark: rgb(255, 167, 255);
|
||||
--newcolor: var(--newcolor-light);
|
||||
}
|
||||
|
||||
html[data-theme="dark"] {
|
||||
--newcolor: var(--newcolor-dark);
|
||||
}
|
||||
|
||||
.newcolor {color: var(--newcolor);}
|
||||
|
||||
.newcolor-same {color: var(--newcolor-light);}
|
||||
|
||||
.newcolor-filter {color: var(--newcolor-light);}
|
||||
|
||||
html[data-theme="dark"] .newcolor-filter {
|
||||
filter: invert(1) hue-rotate(180deg) saturate(1.5);
|
||||
}
|
||||
|
|
@ -78,6 +78,7 @@ parts:
|
|||
- file: external/Sphinx-TUDelft-theme/README.md
|
||||
- file: external/teachbooks-sphinx-tippy/README.md
|
||||
- file: features/apa
|
||||
- file: features/custom_colors.md
|
||||
- file: features/students
|
||||
sections:
|
||||
- file: external/annotater/README.md
|
||||
|
|
|
|||
2
book/external/Nested-Books
vendored
2
book/external/Nested-Books
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit 3cf61525f3985916805a59361935764d78e460df
|
||||
Subproject commit 51f0ba6754f0a5f95032e09482a7a28145687624
|
||||
2
book/external/Sphinx-TUDelft-theme
vendored
2
book/external/Sphinx-TUDelft-theme
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit 7a52c03dad4e50ec592041ee73e9a45558a68ee1
|
||||
Subproject commit 71399c659b037a550a253e38ddacfb33e03cc882
|
||||
2
book/external/deploy-book-workflow
vendored
2
book/external/deploy-book-workflow
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit ed2cdc81be5036deb8da244814a946d17ece7708
|
||||
Subproject commit 317a9cc8607f74f29957b28a86450eccba6a4e2c
|
||||
2
book/external/teachbooks-sphinx-tippy
vendored
2
book/external/teachbooks-sphinx-tippy
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit a80e7645bc5a377b3c75befdf29eb67934bb9ab7
|
||||
Subproject commit 3f9a5c2a72607d5e32c3a99649f37a5e6548e92a
|
||||
2
book/external/template
vendored
2
book/external/template
vendored
|
|
@ -1 +1 @@
|
|||
Subproject commit 6bacc354c7e924ee91dd462abbd23eecf0d154ea
|
||||
Subproject commit 1ea38abf8b30e9076fe315d258655ecf679e4bf2
|
||||
169
book/features/custom_colors.md
Normal file
169
book/features/custom_colors.md
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
# Custom colors
|
||||
|
||||
```{admonition} User types
|
||||
:class: tip
|
||||
This page is useful for user type 4 and 5.
|
||||
```
|
||||
|
||||
Within these online books sometimes extra/new colors are wished for. In this page is shown how this can be achieved.
|
||||
|
||||
## Using `definecolor`
|
||||
|
||||
::::{warning}
|
||||
This method only works for $\LaTeX$ colors.
|
||||
::::
|
||||
|
||||
::::{warning}
|
||||
In this case the color remains the same in ligt and dark mode.
|
||||
::::
|
||||
|
||||
### Code in `_config.yml`
|
||||
|
||||
```yaml
|
||||
sphinx:
|
||||
config:
|
||||
mathjax3_config:
|
||||
tex:
|
||||
macros:
|
||||
"newcolor": ['\definecolor{newcolor}{RGB}{111, 29, 119}{\color{newcolor}#1}',1]
|
||||
```
|
||||
|
||||
### Code in content
|
||||
|
||||
```latex
|
||||
:::{math}
|
||||
\newcolor{\LaTeX}
|
||||
:::
|
||||
```
|
||||
|
||||
### Result
|
||||
|
||||
:::{math}
|
||||
\newcolor{\LaTeX}
|
||||
:::
|
||||
|
||||
## Using CSS
|
||||
|
||||
In this case one has three options:
|
||||
|
||||
1. Light and dark mode the same color
|
||||
1. Light and dark mode different colors using two color definitions
|
||||
1. Light and dark mode different colors using a color filter
|
||||
|
||||
### Light and dark mode the same color
|
||||
|
||||
::::{note}
|
||||
This method has the benefit that the custom color can be used also within html and css elements.
|
||||
::::
|
||||
|
||||
#### Code in `_static/color.css`
|
||||
|
||||
```css
|
||||
:root {
|
||||
--newcolor: rgb(111, 29, 119);
|
||||
}
|
||||
|
||||
.newcolor {color: var(--newcolor);}
|
||||
```
|
||||
|
||||
#### Code in content
|
||||
|
||||
```latex
|
||||
:::{math}
|
||||
\class{newcolor}{\LaTeX}
|
||||
:::
|
||||
```
|
||||
|
||||
```html
|
||||
<div class="newcolor">HTML text</div>
|
||||
```
|
||||
|
||||
#### Result
|
||||
|
||||
:::{math}
|
||||
\class{newcolor-same}{\LaTeX}
|
||||
:::
|
||||
|
||||
<div class="newcolor-same">HTML text</div>
|
||||
|
||||
### Light and dark mode different colors using two color definitions
|
||||
|
||||
::::{note}
|
||||
This method has the benefit that the custom colors can be used also within html and css elements with automatic changes when the mode changes from Light to dark or vice versa.
|
||||
::::
|
||||
|
||||
|
||||
#### Code in `_static/color.css`
|
||||
|
||||
```css
|
||||
:root {
|
||||
--newcolor: rgb(111, 29, 119);
|
||||
}
|
||||
|
||||
html[data-theme="dark"] {
|
||||
--newcolor: rgb(255, 167, 255)
|
||||
}
|
||||
|
||||
.newcolor {color: var(--newcolor);}
|
||||
```
|
||||
|
||||
#### Code in content
|
||||
|
||||
```latex
|
||||
:::{math}
|
||||
\class{newcolor}{\LaTeX}
|
||||
:::
|
||||
```
|
||||
|
||||
```html
|
||||
<div class="newcolor">HTML text</div>
|
||||
```
|
||||
|
||||
#### Result
|
||||
|
||||
:::{math}
|
||||
\class{newcolor}{\LaTeX}
|
||||
:::
|
||||
|
||||
<div class="newcolor">HTML text</div>
|
||||
|
||||
### Light and dark mode different colors using a color filter
|
||||
|
||||
::::{warning}
|
||||
This method has the drawback that the custom colors can only be used as a class.
|
||||
::::
|
||||
|
||||
#### Code in `_static/color.css`
|
||||
|
||||
```css
|
||||
:root {
|
||||
--newcolor: rgb(111, 29, 119);
|
||||
}
|
||||
|
||||
.newcolor {color: var(--newcolor);}
|
||||
|
||||
html[data-theme="dark"] .newcolor {
|
||||
filter: invert(1) hue-rotate(180deg) saturate(1.5);
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
#### Code in content
|
||||
|
||||
```latex
|
||||
:::{math}
|
||||
\class{newcolor}{\LaTeX}
|
||||
:::
|
||||
```
|
||||
|
||||
```html
|
||||
<div class="newcolor">HTML text</div>
|
||||
```
|
||||
|
||||
#### Result
|
||||
|
||||
:::{math}
|
||||
\class{newcolor-filter}{\LaTeX}
|
||||
:::
|
||||
|
||||
<div class="newcolor-filter">HTML text</div>
|
||||
|
|
@ -147,7 +147,10 @@
|
|||
"\n",
|
||||
"```python\n",
|
||||
"%pip install package_name\n",
|
||||
"```"
|
||||
"```\n",
|
||||
"\n",
|
||||
"### Import module from subdirectory\n",
|
||||
"In case you've a module in a subdirectory you cannot do directly `import <module_name> as <local_module_name>`. To solve this, you first have to add that subdirectory to the path with `sys.path.insert(1, '/<module_name/subdirectory>')` (preferably in a hidden cell with `theme-remove-input-init`)"
|
||||
]
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -52,7 +52,9 @@ _Here are a few selected answers from the [Copyright Information Point](https://
|
|||
|
||||
**3) Your own old content**
|
||||
|
||||
Even if created by you, you need to attribute yourself in order to avoid self-plagiarism. Read how to do so [here](https://www.tudelft.nl/library/support/copyright/researcher-copyright-answers#c1131032).
|
||||
Even if created by you, you need to attribute yourself in order to avoid self-plagiarism. If the material has an open license, this is straightforward. If there is no license, or a non-open license, you may need permission from your university (the copyright holder; explained {ref}`here<copyright_considerations_copyright>`). Read more [here](https://www.tudelft.nl/library/support/copyright/teacher-copyright-answers#c1132157)
|
||||
|
||||
If you want to use your own content that a (commercial) publisher has published, you must check your contract to see if you are allowed to use it. Read more [here](https://www.tudelft.nl/library/support/copyright/teacher-copyright-answers#c1132153).
|
||||
|
||||
Even if you have created the work yourself but years ago, check whether you have the right to reuse it. If you have created it while you were under the employment of your previous employer, then you will need to ask permission from them.
|
||||
|
||||
|
|
|
|||
|
|
@ -24,14 +24,17 @@ It appears that copyright law distinguishes between two types of material (not i
|
|||
1. Educational material
|
||||
2. Articles, book (chapter), conference paper, etc.
|
||||
|
||||
We aren't really sure what the definition of _educational material_ is, but since pretty much everything we do is for teaching students or teachers about things, we are pretty sure it includes all of it. Perhaps it is easier to see what is _not_ included in this category,
|
||||
We aren't really sure what the definition of _educational material_ is, but since pretty much everything we do is for teaching students or teachers about things, we are pretty sure it includes all of it. Perhaps it is easier to see a few examples of what is _not_ included: journal article, book (chapter), conference paper.
|
||||
|
||||
```{warning}
|
||||
The TeachBooks Team isn't really sure when the "line is crossed" from educational material to book. More specifically, when the copyright owner is you (the author) or the University (your employer). For now, we assume that all books made by employees of a university are considered educational material.
|
||||
|
||||
Do you have a better answer than this? Let us know!
|
||||
|
||||
If you can read Dutch, the report _Leermaterialen kiezen_ may shed some light on uncertainty about what is considered "educational material" ([download PDF here](https://www.versnellingsplan.nl/wp-content/uploads/2021/08/Digitale-leermaterialen-leermaterialen-kiezen.pdf)).
|
||||
```
|
||||
|
||||
(copyright_considerations_copyright)=
|
||||
## You Don't Own Everything
|
||||
|
||||
The law is very clear on this, and the TU Delft Copyright page states it quite clearly:
|
||||
|
|
@ -48,6 +51,12 @@ In case that wasn't clear enough, _TU Delft owns the copyright,_ not you! In oth
|
|||
|
||||
We recognize that this may make you angry, and we can relate: as teachers we put a lot of effort into the material we create. However, we have come to see that this is _not_ a horrible situation; in fact, it is a good one. As the creator of the material you still retain moral rights to be named as the author, and there are other benefits as well. For example, the ability of other teachers that may take your place after you are gone to legally use and build upon your work in the future.
|
||||
|
||||
```{tip}
|
||||
One reason copyright lies with TU Delft is because educational material must remain available for students when the author leaves. Additional justification can be found in the Open Educational Resources (OER) Policy Document, [here](https://repository.tudelft.nl/record/uuid:68a07efc-fc4d-4a57-8e93-88a3af37465a).
|
||||
|
||||
The use of open licenses actually does not prohibit the author from using the material in the future, even if not employed at TU Delft. For example, if you publish a TeachBook at TU OPEN, with a CC BY license, you are always entitled to "take" the book with you when leaving by simply changing the cover.
|
||||
```
|
||||
|
||||
**Still don't agree?** Sorry. Please take this up with your nearest library or copyright expert and let us know if you get a different response! In the meantime, we will simply list ourselves as authors, use CC BY licenses and remember that TU Delft holds the copyright for our work produced as teachers.
|
||||
|
||||
```{warning}
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ The "ND" license prohibits derivative works: in other words, the material cannot
|
|||
- What if you have a wonderful page describing Topic X, but there are a few contextual phrases that are undesired, for example: "this is required reading for Tuesday, December 17, 2024 in CIEM1000." That would be distracting for your own students, but you can't remove it.
|
||||
- What is the point of including a website together with another website? It's easier to just link to your material directly.
|
||||
- What if someone only wants a small part of your book? They can't use it.
|
||||
- What if someone else makes similar material and releases it under CC BY and you include it in your own book? That does not seem fair to not also provide them an opportunity to benefit from your work.
|
||||
- What if someone else makes similar material and releases it under CC BY and you include it in your own book under an ND license? It seems unfair not to also provide them an opportunity to benefit from your work. In addition, this is not allowed! You can’t put work under a more restrictive license (see also compatibility table below).
|
||||
- Often someone creates a copy of your work and makes improvements. The Git system (e.g., forks, commits, pull requests, etc) make it very straightforward to also include these improvements back into your original work. This would not be possible if you did not allow for reuse in the first place!
|
||||
|
||||
### Why is NC not preferred?
|
||||
|
|
|
|||
|
|
@ -28,7 +28,7 @@ Go to the [TeachBooks Template repository on GitHub](https://github.com/TeachBoo
|
|||
## 3. Let's practice!
|
||||
Getting used to the syntax of writing in a Jupyter Book can be a bit daunting at the start, not to mention becoming familiar with the various tools and workflows required. To help make the learning curve somewhat easier to travel, a number of exercises have been prepared for you The exercises are designed such that no prior experience with any tools or programming is required, as long as you have read the preceding introductory pages.
|
||||
|
||||
The exercises can be found in your book at `https://<username or organiszation_name>.github.io/<repository_name>/exercises/exercises` (case sensitive) or at https://teachbooks.io/template/exercises/exercises.html.
|
||||
The exercises can be found in your book at `https://<username or organiszation_name>.github.io/<repository_name>/exercises/exercises` (case sensitive) or at https://teachbooks.io/template/exercises.html.
|
||||
|
||||
```{figure} ../external/template/figures/exercises.png
|
||||
---
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue