Skip to content

Commit 5557d78

Browse files
first commit
0 parents  commit 5557d78

File tree

218 files changed

+679500
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

218 files changed

+679500
-0
lines changed
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: call-deploy-book
2+
3+
on:
4+
push:
5+
branches:
6+
- '**'
7+
# If your git repository has the Jupyter Book within some-subfolder next to
8+
# unrelated files, you can make this run only if a file within that specific
9+
# folder (or the workflow file itself) has been modified.
10+
#
11+
paths:
12+
- book/**
13+
- requirements.txt
14+
- .github/workflows/call-deploy-book.yml
15+
workflow_dispatch:
16+
17+
jobs:
18+
call-workflow:
19+
uses: TeachBooks/deploy-book-workflow/.github/workflows/deploy-book.yml@v1
20+
secrets: inherit
21+
permissions:
22+
contents: read
23+
pages: write
24+
id-token: write
25+

.gitignore

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[cod]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
pip-wheel-metadata/
24+
share/python-wheels/
25+
*.egg-info/
26+
.installed.cfg
27+
*.egg
28+
MANIFEST
29+
.vscode/
30+
31+
# PyInstaller
32+
# Usually these files are written by a python script from a template
33+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
34+
*.manifest
35+
*.spec
36+
37+
# Installer logs
38+
pip-log.txt
39+
pip-delete-this-directory.txt
40+
41+
# Unit test / coverage reports
42+
htmlcov/
43+
.tox/
44+
.nox/
45+
.coverage
46+
.coverage.*
47+
.cache
48+
nosetests.xml
49+
coverage.xml
50+
*.cover
51+
*.py,cover
52+
.hypothesis/
53+
.pytest_cache/
54+
55+
# Translations
56+
*.mo
57+
*.pot
58+
59+
# Django stuff:
60+
*.log
61+
local_settings.py
62+
db.sqlite3
63+
db.sqlite3-journal
64+
65+
# Flask stuff:
66+
instance/
67+
.webassets-cache
68+
69+
# Scrapy stuff:
70+
.scrapy
71+
72+
# Sphinx documentation
73+
docs/_build/
74+
75+
# PyBuilder
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
.python-version
87+
88+
# pipenv
89+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
90+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
91+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
92+
# install all needed dependencies.
93+
#Pipfile.lock
94+
95+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
96+
__pypackages__/
97+
98+
# Celery stuff
99+
celerybeat-schedule
100+
celerybeat.pid
101+
102+
# SageMath parsed files
103+
*.sage.py
104+
105+
# Environments
106+
.env
107+
.venv
108+
env/
109+
venv/
110+
ENV/
111+
env.bak/
112+
venv.bak/
113+
114+
# Spyder project settings
115+
.spyderproject
116+
.spyproject
117+
118+
# Rope project settings
119+
.ropeproject
120+
121+
# mkdocs documentation
122+
/site
123+
124+
# mypy
125+
.mypy_cache/
126+
.dmypy.json
127+
dmypy.json
128+
129+
# Pyre type checker
130+
.pyre/
131+
132+
# Jupyter Book
133+
_build/
134+
.teachbooks/
135+
136+
# poetry files
137+
pyproject.toml

CITATION.cff

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
3+
4+
cff-version: 1.2.0
5+
title: 'TeachBooks Template' # replace with your own book title when you use this template
6+
authors: #replace with your own name(s) if you use this template
7+
8+
name: 'TeachBooks Development Team'
9+
website: 'https://teachbooks.io/'
10+
message: 'If you use this teachbook, please cite it using these metadata.'
11+
preferred-citation:
12+
type: book
13+
authors: #replace with your own name(s) if you use this template
14+
15+
name: 'TeachBooks Development Team'
16+
website: 'https://teachbooks.io/'
17+
# - given-names: Tom
18+
# name-particle: van
19+
# family-names: Woudenberg
20+
21+
# affiliation: TeachBooks
22+
# orcid: 'https://orcid.org/0000-0002-9536-061X'
23+
url: 'https://teachbooks.github.io/template/' # replace with your own URL (book website / publisher link) when you use this template
24+
identifiers:
25+
- type: url
26+
value: 'https://teachbooks.github.io/template/' # replace with your own URL when you use this template
27+
description: 'Published book on GitHub Pages'
28+
- type: url
29+
value: 'https://github.com/TeachBooks/template' # replace with your own URL when you use this template
30+
description: 'GitHub repository'
31+
abstract: >- # replace with your own abstract when you use this template
32+
The template allows you to start your own TeachBook and
33+
hosting that TeachBook online without knowledge on Git,
34+
the Jupyter book package, python or anaconda. It doesn't
35+
elaborate on the collaborative functionalities of Git or
36+
how to edit the book
37+
keywords: # replace with your own keywords when you use this template
38+
- TeachBooks
39+
- Template
40+
- 'Jupyter Book'
41+
title: 'TeachBooks Template' # replace with your own book title when you use this template
42+
institution:
43+
name: 'TeachBooks' # replace with your own institution when you use this template
44+
license: CC-BY-4.0
45+
license-url: 'https://creativecommons.org/licenses/by/4.0/'
46+
copyright: '© 2025 TeachBooks' # replace with your own affiliation / name when you use this template
47+
languages:
48+
- en # replace with your book language when you use this template
49+
contact: # replace with your own contact information when you use this template
50+
51+
name: 'TeachBooks Development Team'

CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# All files in the repo
2+
* @Tom-van-Woudenberg

CODE_OF_CONDUCT.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this book, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, updating content, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
- The use of sexualized language or imagery
10+
- Personal attacks
11+
- Trolling or insulting/derogatory comments
12+
- Public or private harassment
13+
- Publishing other’s private information, such as physical or electronic addresses, without explicit permission
14+
- Other unethical or unprofessional conduct
15+
16+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
17+
18+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21+
22+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 1.2.0, available at [https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html](https://www.contributor-covenant.org/version/1/2/0/code-of-conduct.html)

0 commit comments

Comments
 (0)