Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html
title: Introduction to particle and continuum physics
author: Timon Idema
logo: tudelft.png
description: Introduction-level physics book covering classical mechanics (forces, energy, momentum, angular momentum), oscillations, waves, elementary continuum mechanics (elasticity and fluids) and thermodynamics.
copyright: Delft University of Technology, CC BY 4.0
# Only build files in the ToC to avoid building README, etc.
only_build_toc_files: true
# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: force
# Define the name of the latex output file for PDF builds
latex:
latex_documents:
targetname: physics1Abook.tex
# Add a bibtex file so that we can create citations
bibtex_bibfiles:
- references.bib
# Sphinx, for html formatting. Needs checking version.
# Mathjax config allows us to define tex macros. Note that we need to escape the \ in a latex math command with an extra \.
# I have no idea what the html_js_files link does (TODO!). See https://cdnjs.com/libraries/require.js and https://cdnjs.cloudflare.com
# Unfortunately, the mathjax3_config loader options break (!) mathjax for markdown files that have a jupytext yaml block. But not loading prevents us from using the physics or boldmatch packages. Clearly this is a bug, needs reporting.
# The bibtex_reference_style is 'Use numeric reference labels, citations are sorted by order of appearance.' Alternatives include alpha, plain, and unsrtalpha. See https://jupyterbook.org/en/stable/content/citations.html
# We don't use this option as we go for local references instead, adding them to individual 'chapter' pages.
# The sphinx_proof extension requires installing the sphinx-proof package, see https://jupyterbook.org/en/stable/content/proof.html
# Likewise, the sphinx_exercise requires installing the sphinx-exercise package.
# The local extension applet.py allows us to include applets (developed by Julia van de Kris and Abel de Bruijn for the linear algebra open textbook; source https://gist.github.com/yustarandomname/2be0f45758d0fe3d2d765da4e621a547). See https://jupyterbook.org/en/stable/advanced/sphinx.html#local-sphinx-extensions about the local extensions.
sphinx:
config:
# html_js_files necessary for interactive plot (plotly) in ch. 2, but breaks applet in ch. 3. cf. https://jupyterbook.org/en/stable/interactive/interactive.html?highlight=html_js_files#plotly
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
html_js_files:
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js
mathjax3_config:
#loader: {load: ['[tex]/ams', '[tex]/physics', '[tex]/boldsymbol']}
loader: {load: ['[tex]/autoload', '[tex]/ams']}
tex:
packages: {'[+]': ['autoload', 'ams', 'physics', 'boldsymbol']}
tags: 'ams'
macros:
"kB" : "k_\\mathrm{B}"
"Rn" : "\\mathrm{Re}"
#"bm" : "\\boldsymbol"
#"bm": "\\vb*"
"bm": "\\mathbf"
"inprod" : "\\innerproduct"
"diff" : "\\pdv"
# bibtex_reference_style: unsrt
# local_extensions: # For the applet inclusion.
# applet: _ext/
extra_extensions:
- sphinx_proof
- sphinx_exercise
- sphinx_togglebutton
# - sphinx_tojupyter
# Parse, for processing LaTeX-style math. See https://jupyterbook.org/en/stable/content/math.html#latex-style-math and https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-amsmath
parse:
myst_enable_extensions:
# don't forget to list any other extensions you want enabled,
# including those that are enabled by default!
# meaning that we have to explicitly include dollarmath!
# Colon-fence is to allow for ::: instead of ``` blocks.
- amsmath
- dollarmath
# Information about where the book exists on the web
repository:
url: https://gitlab.tudelft.nl/opentextbooks/NB1140/ # Online location of your book
# path_to_book: docs # Optional path to your book, relative to the repository root
branch: master # Which branch of the repository should be used when creating links (optional)
# HTML specific settings - see https://jupyterbook.org/en/stable/customize/config.html
# Add GitHub / GitLab buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
favicon: "content/images/favicon.ico"
#use_issues_button: true
use_repository_button: true
extra_navbar: "" # Will be displayed underneath the left navbar. This setting overrides the default 'powered by Jupyter Book'
comments:
hypothesis: true # Hypothesis for comments