From 0417de8ebc6efa0af72ba44ee73139d868ee1862 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 08:19:00 +0200 Subject: [PATCH 01/19] Update _config.yml with TeachBooks attribution settings --- book/_config.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/book/_config.yml b/book/_config.yml index 2805148..584ff66 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -40,8 +40,13 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier } + named_colors_custom_colors: {'attributiongrey':[150,150,150]} # Defines grey colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) extra_extensions: - teachbooks_favourites # Gives you a starter package of extensions to use in your book, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) +teachbooks: + attribution_location: top # Default value, sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) + attribution_color: attributiongrey # Sets grey colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) + bibtex_bibfiles: - references.bib # Required for references From 30909e1406b49b9c44bfad8e6eff7dfe24962004 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 08:20:50 +0200 Subject: [PATCH 02/19] Create attribution.css for TeachBooks package --- book/_static/attribution.css | 4 ++++ 1 file changed, 4 insertions(+) create mode 100644 book/_static/attribution.css diff --git a/book/_static/attribution.css b/book/_static/attribution.css new file mode 100644 index 0000000..4c71166 --- /dev/null +++ b/book/_static/attribution.css @@ -0,0 +1,4 @@ +/* Set attribution admonition symbol, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) */ +div.attribution > .admonition-title::after { + content: "\f10d"; +} From 776d252faacf6788b78cedba637d48dc1df42e42 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 08:56:38 +0200 Subject: [PATCH 03/19] Modify _config.yml for Sphinx settings Updated configuration options for live code and added new settings for Sphinx extensions. --- book/_config.yml | 37 ++++++++++++++++++++++++++++++------- 1 file changed, 30 insertions(+), 7 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index 584ff66..fd475ba 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -16,10 +16,10 @@ sphinx: # Options passed on to the config: language: en # Defines language (English) of everything except the content itself. For Dutch: replace with `nl` html_js_files: - - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js # Required for live code: https://teachbooks.io/manual/features/live_code.html + - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) thebe_config: - use_thebe_lite: true # Required for live code: https://teachbooks.io/manual/features/live_code.html - exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] #exclude files which should not be accessible for live code: https://teachbooks.io/manual/features/live_code.html + use_thebe_lite: true # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) + exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] #exclude files which should not be accessible for live code, configuration part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) html_theme_options: logo: text: Template # Replace this with your own book title @@ -32,7 +32,7 @@ sphinx: # Options passed on to the use_repository_button: true # Replace with false if you don't want the repository button (i.e. if you have a private repo) use_issues_button : true # Replace with false if you don't want the issues button (i.e. if you don't want to use GitHub issues or have a private repo) launch_buttons: - thebe: true # Required for live code: https://teachbooks.io/manual/features/live_code.html + thebe: true # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) html_show_copyright: false # As the copyright is included in the author field html_last_updated_fmt: '%B %-d, %Y' # Adds the date of the last update to the footer html_static_path: ["figures"] # Add folder that contain files that need to be included, such as the location of the logo(s) @@ -40,13 +40,36 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier } - named_colors_custom_colors: {'attributiongrey':[150,150,150]} # Defines grey colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) + patch_config: + disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) + inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) + inverter_saturation: 1.5 # Default value (line can be removed), sets saturation of figures in dark mode to 1.5, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) + iframe_blend: true # Default value (line can be removed), blends all iframes with the background and in dark-mode also inverted., configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html) + iframe_saturation: 1.5 # Default value (line can be removed), sets saturation of iframes in dark mode to 1.5, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html) + iframe_h5p_autoresize: true # Default value (line can be removed), automagically resized all h5p elements to fit the element in which the iframe is loadeds, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html) + iframe_background: "#ffffff" # Default value (line can be removed), sets the standard background color of non-blended iframes to white, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html) + iframe_width: calc(100% - 2.8rem) # Default value (line can be removed), sets the standard width of the iframe within the parent element, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html) + iframe_aspectratio: auto 2 / 1 # Default value (line can be removed), sets the standard aspect ration of the iframe within the parent element, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html) + hide_solutions: false # Default value (line can be removed), does not hide all solutions from exercises, configuration part of Sphinx-Exercise (https://ebp-sphinx-exercise.readthedocs.io/en/latest/syntax.html) + named_colors_include_CSS: true # Default value (line can be removed), includes all CSS colours, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) + named_colors_dark_and_light: true # Default value (line can be removed), creates dark mode colours for CSS and custom named colours, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) + named_colors_saturation: 1.5 # Default value (line can be removed), sets saturation of CSS and custom named colours in dark mode to 1.5, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) + named_colors_custom_colors: None # Default value (line can be removed), defines no custom named colours (include no colour for attribution admonition of external pages), configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) + proof_minimal_theme: false # Default value (line can be removed), uses default color scheme for admonitions part of sphinx-proof, configuration part of Sphinx-Proof (https://sphinx-proof.readthedocs.io/en/latest/options.html) + sphinx_codex_name: "" # Default value (line can be removed), uses default 'Code example' as title for codex directives, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) + sphinx_codex_style_from_proof: true # Default value (line can be removed), the CSS color style of the codex directive will be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) + sphinx_codex_icon_from_proof: false # Default value (line can be removed), the icon of the codex directive will not be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) + sphinx_codex_merge_with_proof: false # Default value (line can be removed), the codex directive will not be merged with the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) + sphinx_togglebutton_selector: ".toggle, .admonition.dropdown" # Default value (line can be removed), configures the CSS selector used to insert toggle buttons, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html + togglebutton_hint: "Click to show" # Default value (line can be removed), defines hint when toggle is closed, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html + togglebutton_hint_hide: "Click to hide" # Default value (line can be removed), defines hint when toggle is opened, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html + togglebutton_open_on_print: true # Default value (line can be removed), opens all toggle-able content when you print, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html extra_extensions: - teachbooks_favourites # Gives you a starter package of extensions to use in your book, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) teachbooks: - attribution_location: top # Default value, sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) - attribution_color: attributiongrey # Sets grey colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) + attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) + attribution_color: None # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) bibtex_bibfiles: - references.bib # Required for references From 096cd840ff0212073de5d5177d174c86c217a246 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 08:58:05 +0200 Subject: [PATCH 04/19] Delete book/_static directory --- book/_static/attribution.css | 4 ---- 1 file changed, 4 deletions(-) delete mode 100644 book/_static/attribution.css diff --git a/book/_static/attribution.css b/book/_static/attribution.css deleted file mode 100644 index 4c71166..0000000 --- a/book/_static/attribution.css +++ /dev/null @@ -1,4 +0,0 @@ -/* Set attribution admonition symbol, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) */ -div.attribution > .admonition-title::after { - content: "\f10d"; -} From dc8021453ec6686def617f02ff4d3e0a9ecbcd7e Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 09:05:11 +0200 Subject: [PATCH 05/19] Update TeachBooks-Favourites dependency version --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index 0479af9..e76d771 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,4 @@ teachbooks # depends on jupyter-book # Our favourite Sphinx extensions in one line, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) -git+https://github.com/TeachBooks/TeachBooks-Favourites +git+https://github.com/TeachBooks/TeachBooks-Favourites #BUMP From 951dd32e8b1929e48a3a56c38124a3fbd529677d Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 09:05:30 +0200 Subject: [PATCH 06/19] Update TeachBooks Favourites repository URL --- requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/requirements.txt b/requirements.txt index e76d771..0479af9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -2,4 +2,4 @@ teachbooks # depends on jupyter-book # Our favourite Sphinx extensions in one line, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) -git+https://github.com/TeachBooks/TeachBooks-Favourites #BUMP +git+https://github.com/TeachBooks/TeachBooks-Favourites From e876328b7ccb45b06584e866870eeda6de849003 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 15:34:43 +0200 Subject: [PATCH 07/19] Change None to null in YAML configuration --- book/_config.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index fd475ba..2c97ae9 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -54,7 +54,7 @@ sphinx: # Options passed on to the named_colors_include_CSS: true # Default value (line can be removed), includes all CSS colours, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) named_colors_dark_and_light: true # Default value (line can be removed), creates dark mode colours for CSS and custom named colours, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) named_colors_saturation: 1.5 # Default value (line can be removed), sets saturation of CSS and custom named colours in dark mode to 1.5, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) - named_colors_custom_colors: None # Default value (line can be removed), defines no custom named colours (include no colour for attribution admonition of external pages), configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) + named_colors_custom_colors: null # Default value (line can be removed), defines no custom named colours (include no colour for attribution admonition of external pages), configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html) proof_minimal_theme: false # Default value (line can be removed), uses default color scheme for admonitions part of sphinx-proof, configuration part of Sphinx-Proof (https://sphinx-proof.readthedocs.io/en/latest/options.html) sphinx_codex_name: "" # Default value (line can be removed), uses default 'Code example' as title for codex directives, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) sphinx_codex_style_from_proof: true # Default value (line can be removed), the CSS color style of the codex directive will be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) @@ -69,7 +69,7 @@ sphinx: # Options passed on to the teachbooks: attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) - attribution_color: None # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) + attribution_color: null # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) bibtex_bibfiles: - references.bib # Required for references From e8a609c5fa6c23cb85fd0341796ffee0723d2b61 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 15:36:36 +0200 Subject: [PATCH 08/19] Remove sphinx_togglebutton_selector from config --- book/_config.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 2c97ae9..49934f7 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -60,7 +60,6 @@ sphinx: # Options passed on to the sphinx_codex_style_from_proof: true # Default value (line can be removed), the CSS color style of the codex directive will be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) sphinx_codex_icon_from_proof: false # Default value (line can be removed), the icon of the codex directive will not be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) sphinx_codex_merge_with_proof: false # Default value (line can be removed), the codex directive will not be merged with the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) - sphinx_togglebutton_selector: ".toggle, .admonition.dropdown" # Default value (line can be removed), configures the CSS selector used to insert toggle buttons, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html togglebutton_hint: "Click to show" # Default value (line can be removed), defines hint when toggle is closed, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html togglebutton_hint_hide: "Click to hide" # Default value (line can be removed), defines hint when toggle is opened, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html togglebutton_open_on_print: true # Default value (line can be removed), opens all toggle-able content when you print, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html From 23259583f6e55b755f8e04051c996090f69123c4 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 16:00:19 +0200 Subject: [PATCH 09/19] Update _config.yml --- book/_config.yml | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index 49934f7..9c0bfa3 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,9 +1,7 @@ -title: TeachBooks template # Replace this with your own book title author: TeachBooks Team, built with TeachBooks, CC BY 4.0 - # Replace TeachBooks Teams with your own name in the line above - + # Replace TeachBooks Teams with your own name in the line above, configuratin part of JupyterBook: https://jupyterbook.org/en/stable/customize/config.html execute: - execute_notebooks: "off" # Replace this if you want don't have notebooks with output and you want to add notebook output during build + execute_notebooks: "off" # Replace this if you want don't have notebooks with output and you want to add notebook output during build, configuration part of jupyterbook: https://jupyterbook.org/en/stable/customize/config.html only_build_toc_files: true # Replace this with false if you want to build all files in the book, allowing you to refer to pages which are not included in the table of contents @@ -63,6 +61,19 @@ sphinx: # Options passed on to the togglebutton_hint: "Click to show" # Default value (line can be removed), defines hint when toggle is closed, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html togglebutton_hint_hide: "Click to hide" # Default value (line can be removed), defines hint when toggle is opened, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html togglebutton_open_on_print: true # Default value (line can be removed), opens all toggle-able content when you print, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html + tippy_props: {"placement": "auto-start", "maxWidth": 500, "interactive": True, "boundary": "document.body", "appendTo": "document.body"} # Default value (line can be removed), sets tippy properties, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_add_class: null # Default value (line can be removed), adds a class name to all elements with tips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_skip_urls: null # Default value (line can be removed), a list of URL regexes to skip, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_tip_selector: "figure, table, img, p, aside, div.admonition, div.literal-block-wrapper" # Default value (line can be removed), defines what elements tips are created for, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_skip_anchor_classes: ("headerlink", "sd-stretched-link",) # Default value (line can be removed), skips showing tooltips for anchors with these classes, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_anchor_parent_selector: null # Default value (line can be removed), only show tool tips for anchors within this select, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_enable_wikitips: true # Default value (line can be removed), enables tooltips for wikipedia links, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_enable_doitips: true # Default value (line can be removed), enables tooltips for DOI links, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_doi_api: "https://api.crossref.org/works/" # Default value (line can be removed), sets the API to use for DOI tooltips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + #tippy_doi_template # Default value not shown (line can be removed), sets the jinja template to use for formatting DOI data to tooltips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_custom_tips: null # Default value (line can be removed), creates custom tips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_enable_mathjax: true # Default value (line can be removed), enables tooltips for math equations, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props + tippy_js: ("https://unpkg.com/@popperjs/core@2", "https://unpkg.com/tippy.js@6") # Default value (line can be removed), sets the Javascript required to enable tooltips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props extra_extensions: - teachbooks_favourites # Gives you a starter package of extensions to use in your book, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) From f3e4d8b43fd51ae37742a0542bed9d175e37b067 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 17:01:47 +0200 Subject: [PATCH 10/19] Update _config.yml --- book/_config.yml | 102 +++++++++++++++++++++++++++++------------------ 1 file changed, 63 insertions(+), 39 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index 9c0bfa3..1e9576f 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -1,18 +1,30 @@ +# This config includes all the recommended (default) configuration options of the TeachBooks software, and a TeachBooks' selection of configuration options as provided by Jupyter Book for Jupyter Book software and Sphinx. + author: TeachBooks Team, built with TeachBooks, CC BY 4.0 # Replace TeachBooks Teams with your own name in the line above, configuratin part of JupyterBook: https://jupyterbook.org/en/stable/customize/config.html execute: - execute_notebooks: "off" # Replace this if you want don't have notebooks with output and you want to add notebook output during build, configuration part of jupyterbook: https://jupyterbook.org/en/stable/customize/config.html - -only_build_toc_files: true # Replace this with false if you want to build all files in the book, allowing you to refer to pages which are not included in the table of contents - + execute_notebooks: "off" # Replace this if you want don't have notebooks with output and you want to add notebook output during build, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + cache: `_build/.jupyter_cache/` # Default value (line can be removed), sets path to the jupyter cache that will be used to store execution artifacts, doesn't work in GitHub workflow, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + exclude_patterns: [] # Default value (line can be removed), sets a list of patterns to *skip* in execution, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html), can overwritten by Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html) + timeout: 30 # Default value (line can be removed), sets he maximum time (in seconds) each notebook cell is allowed to run, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + run_in_temp: false # Default value (line can be removed), disables a temporary directory was the command working directory (cwd), configuration part Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + allow_errors: false # Default value (line can be removed), all cells are always run, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + stderr_output: show # Default value (line can be removed), shows stderr output, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + +only_build_toc_files: true # Replace this with false if you want to build all files in the book, allowing you to refer to pages which are not included in the table of contents, configuration part of jupyterbook: https://jupyterbook.org/en/stable/customize/config.html html: - favicon : "figures/TB_favicon.ico" # Replace this with your own favicon - baseurl : "https://.io/" # Replace this with your own URL + favicon: "figures/TB_favicon.ico" # Replace this with your own favicon, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + baseurl: "https://.io/" # Replace this with your own URL, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + use_multitoc_numbering : true # Default value (line can be removed), sets continuous numbering across parts/chapters, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + extra_footer : "" # Default value (line can be removed), sets text to be displayed underneath the footer, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) sphinx: # Options passed on to the underlying sphinx-parser + extra_extensions: # Sets a list of extensions to load by sphinx, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + - teachbooks_favourites # Gives you a starter package of extensions to use in your book, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) + local_extension: null # Sets a a list of local extensions to load by sphinx, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) config: - language: en # Defines language (English) of everything except the content itself. For Dutch: replace with `nl` + language: en # Defines language (English) of everything except the content itself. For Dutch: replace with `nl`, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) html_js_files: - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) thebe_config: @@ -20,23 +32,24 @@ sphinx: # Options passed on to the exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] #exclude files which should not be accessible for live code, configuration part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) html_theme_options: logo: - text: Template # Replace this with your own book title - image_light: TeachBooks_logo.svg # Put your logo for the light mode here (can be the same as image_dark) - image_dark: TeachBooks_logo_inverted.svg # Put your logo for the dark mode here (can be the same as image_light) - repository_url: "https://github.com/user/repo" # Add your own repo URL here - path_to_docs: "book" # Required for edit_page_button, should be book if you're using TeachBooks package (https://github.com/TeachBooks/TeachBooks) or the TeachBooks deploy book workflow (https://teachbooks.io/manual/external/deploy-book-workflow/README.html) - repository_branch: "main" # Replace when you change the name of your published branch (required for edit_page_button) - use_edit_page_button: true # Replace with false if you don't want the edit page button (i.e. if you don't user to propose changes themselves or have a private repo) - use_repository_button: true # Replace with false if you don't want the repository button (i.e. if you have a private repo) - use_issues_button : true # Replace with false if you don't want the issues button (i.e. if you don't want to use GitHub issues or have a private repo) + text: Template # Replace this with your own book title, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + image_light: TeachBooks_logo.svg # Put your logo for the light mode here (can be the same as image_dark), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + image_dark: TeachBooks_logo_inverted.svg # Put your logo for the dark mode here (can be the same as image_light), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + repository_url: "https://github.com/user/repo" # Add your own repo URL here, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + path_to_docs: "book" # Required for edit_page_button, should be book if you're using TeachBooks package (https://github.com/TeachBooks/TeachBooks) or the TeachBooks deploy book workflow (https://teachbooks.io/manual/external/deploy-book-workflow/README.html), configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + repository_branch: "main" # Replace when you change the name of your published branch (required for edit_page_button), configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + use_edit_page_button: true # Replace with false if you don't want the edit page button (i.e. if you don't user to propose changes themselves or have a private repo), configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + use_repository_button: true # Replace with false if you don't want the repository button (i.e. if you have a private repo), configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + use_issues_button : true # Replace with false if you don't want the issues button (i.e. if you don't want to use GitHub issues or have a private repo), configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) launch_buttons: thebe: true # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) - html_show_copyright: false # As the copyright is included in the author field - html_last_updated_fmt: '%B %-d, %Y' # Adds the date of the last update to the footer - html_static_path: ["figures"] # Add folder that contain files that need to be included, such as the location of the logo(s) + announcement: "" # Default value (line can be removed), sets a banner announcement at the top of the site, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) + html_show_copyright: false # As the copyright is included in the author field, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + html_last_updated_fmt: '%B %-d, %Y' # Adds the date of the last update to the footer, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + html_static_path: ["figures"] # Add folder that contain files that need to be included, such as the location of the logo(s), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) mathjax3_config: chtml: { - mtextInheritFont: true # To typeset text within math prettier + mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) @@ -58,28 +71,39 @@ sphinx: # Options passed on to the sphinx_codex_style_from_proof: true # Default value (line can be removed), the CSS color style of the codex directive will be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) sphinx_codex_icon_from_proof: false # Default value (line can be removed), the icon of the codex directive will not be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) sphinx_codex_merge_with_proof: false # Default value (line can be removed), the codex directive will not be merged with the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html) - togglebutton_hint: "Click to show" # Default value (line can be removed), defines hint when toggle is closed, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html - togglebutton_hint_hide: "Click to hide" # Default value (line can be removed), defines hint when toggle is opened, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html - togglebutton_open_on_print: true # Default value (line can be removed), opens all toggle-able content when you print, configuration part of https://sphinx-togglebutton.readthedocs.io/en/latest/use.html - tippy_props: {"placement": "auto-start", "maxWidth": 500, "interactive": True, "boundary": "document.body", "appendTo": "document.body"} # Default value (line can be removed), sets tippy properties, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_add_class: null # Default value (line can be removed), adds a class name to all elements with tips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_skip_urls: null # Default value (line can be removed), a list of URL regexes to skip, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_tip_selector: "figure, table, img, p, aside, div.admonition, div.literal-block-wrapper" # Default value (line can be removed), defines what elements tips are created for, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_skip_anchor_classes: ("headerlink", "sd-stretched-link",) # Default value (line can be removed), skips showing tooltips for anchors with these classes, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_anchor_parent_selector: null # Default value (line can be removed), only show tool tips for anchors within this select, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_enable_wikitips: true # Default value (line can be removed), enables tooltips for wikipedia links, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_enable_doitips: true # Default value (line can be removed), enables tooltips for DOI links, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_doi_api: "https://api.crossref.org/works/" # Default value (line can be removed), sets the API to use for DOI tooltips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - #tippy_doi_template # Default value not shown (line can be removed), sets the jinja template to use for formatting DOI data to tooltips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_custom_tips: null # Default value (line can be removed), creates custom tips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_enable_mathjax: true # Default value (line can be removed), enables tooltips for math equations, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - tippy_js: ("https://unpkg.com/@popperjs/core@2", "https://unpkg.com/tippy.js@6") # Default value (line can be removed), sets the Javascript required to enable tooltips, configuration part of https://sphinx-tippy.readthedocs.io/en/latest/#confval-tippy_props - extra_extensions: - - teachbooks_favourites # Gives you a starter package of extensions to use in your book, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites) + togglebutton_hint: "Click to show" # Default value (line can be removed), defines hint when toggle is closed, configuration part of Sphinx-Togglebutton (https://sphinx-togglebutton.readthedocs.io/en/latest/use.html) + togglebutton_hint_hide: "Click to hide" # Default value (line can be removed), defines hint when toggle is opened, configuration part of Sphinx-Togglebutton (https://sphinx-togglebutton.readthedocs.io/en/latest/use.html) + togglebutton_open_on_print: true # Default value (line can be removed), opens all toggle-able content when you print, configuration part of Sphinx-Togglebutton (https://sphinx-togglebutton.readthedocs.io/en/latest/use.html) + nb_execution_includepatterns: [] # Default value (line can be removed), sets a a list of glob patterns to indicate notebooks that must be included for execution, configuration part of Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html) + nb_execution_patterns_method: "only_include" # Default value (line can be removed), sets the method used when both include and exclude patterns are provided, configuration part of Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html) + tippy_props: {"placement": "auto-start", "maxWidth": 500, "interactive": True, "boundary": "document.body", "appendTo": "document.body"} # Default value (line can be removed), sets tippy properties, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_add_class: null # Default value (line can be removed), adds a class name to all elements with tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_skip_urls: "" # Default value (line can be removed), a list of URL regexes to skip, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_tip_selector: "figure, table, img, p, aside, div.admonition, div.literal-block-wrapper" # Default value (line can be removed), defines what elements tips are created for, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_skip_anchor_classes: ("headerlink", "sd-stretched-link",) # Default value (line can be removed), skips showing tooltips for anchors with these classes, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_anchor_parent_selector: null # Default value (line can be removed), only show tool tips for anchors within this select, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_enable_wikitips: true # Default value (line can be removed), enables tooltips for wikipedia links, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_enable_doitips: true # Default value (line can be removed), enables tooltips for DOI links, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_doi_api: "https://api.crossref.org/works/" # Default value (line can be removed), sets the API to use for DOI tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_doi_template # Default value not shown (line can be removed), sets the jinja template to use for formatting DOI data to tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_custom_tips: null # Default value (line can be removed), creates custom tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_enable_mathjax: true # Default value (line can be removed), enables tooltips for math equations, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + tippy_js: ("https://unpkg.com/@popperjs/core@2", "https://unpkg.com/tippy.js@6") # Default value (line can be removed), sets the Javascript required to enable tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) teachbooks: attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) attribution_color: null # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) bibtex_bibfiles: - - references.bib # Required for references + - references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + +# Parse and render settings +parse: + myst_enable_extensions: # Default values (lines can be removed), sets extensions to enable in the myst parser, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html) + - colon_fence + - dollarmath + - linkify + - substitution + - tasklist + myst_url_schemes: [mailto, http, https] # Default value (lines can be removed), sets URI schemes that will be recognised as external URLs in Markdown links, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html) + myst_dmath_double_inline: true # Default value (lines can be removed), allows display math ($$) within an inline context, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html) From 613c07257f4745e2d3c40939b87d01a844d7fd0a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 17:04:37 +0200 Subject: [PATCH 11/19] Fix cache path format in _config.yml --- book/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 1e9576f..7dde32f 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -4,7 +4,7 @@ author: TeachBooks Team, built with TeachBooks Date: Sun, 14 Sep 2025 17:07:29 +0200 Subject: [PATCH 12/19] Update _config.yml --- book/_config.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index 7dde32f..d04c7f6 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -77,18 +77,18 @@ sphinx: # Options passed on to the nb_execution_includepatterns: [] # Default value (line can be removed), sets a a list of glob patterns to indicate notebooks that must be included for execution, configuration part of Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html) nb_execution_patterns_method: "only_include" # Default value (line can be removed), sets the method used when both include and exclude patterns are provided, configuration part of Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html) tippy_props: {"placement": "auto-start", "maxWidth": 500, "interactive": True, "boundary": "document.body", "appendTo": "document.body"} # Default value (line can be removed), sets tippy properties, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) - tippy_add_class: null # Default value (line can be removed), adds a class name to all elements with tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) - tippy_skip_urls: "" # Default value (line can be removed), a list of URL regexes to skip, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_add_class # Default value not shown (line can be removed), adds a class name to all elements with tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_skip_urls # Default value not shown (line can be removed), a list of URL regexes to skip, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) tippy_tip_selector: "figure, table, img, p, aside, div.admonition, div.literal-block-wrapper" # Default value (line can be removed), defines what elements tips are created for, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) - tippy_skip_anchor_classes: ("headerlink", "sd-stretched-link",) # Default value (line can be removed), skips showing tooltips for anchors with these classes, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) - tippy_anchor_parent_selector: null # Default value (line can be removed), only show tool tips for anchors within this select, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_skip_anchor_classes # Default value not shown (line can be removed), skips showing tooltips for anchors with these classes, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_anchor_parent_selector # Default value not shown (line can be removed), only show tool tips for anchors within this select, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) tippy_enable_wikitips: true # Default value (line can be removed), enables tooltips for wikipedia links, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) tippy_enable_doitips: true # Default value (line can be removed), enables tooltips for DOI links, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) tippy_doi_api: "https://api.crossref.org/works/" # Default value (line can be removed), sets the API to use for DOI tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) #tippy_doi_template # Default value not shown (line can be removed), sets the jinja template to use for formatting DOI data to tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) - tippy_custom_tips: null # Default value (line can be removed), creates custom tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_custom_tips # Default value not shown (line can be removed), creates custom tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) tippy_enable_mathjax: true # Default value (line can be removed), enables tooltips for math equations, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) - tippy_js: ("https://unpkg.com/@popperjs/core@2", "https://unpkg.com/tippy.js@6") # Default value (line can be removed), sets the Javascript required to enable tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) + #tippy_js # Default value not shown (line can be removed), sets the Javascript required to enable tooltips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html) teachbooks: attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) From e1b8b339df90dfa0481939a8e6e3c50f03642754 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 18:22:17 +0200 Subject: [PATCH 13/19] Set sphinx options as sphinx options --- book/_config.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index d04c7f6..eba762b 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -14,8 +14,6 @@ execute: only_build_toc_files: true # Replace this with false if you want to build all files in the book, allowing you to refer to pages which are not included in the table of contents, configuration part of jupyterbook: https://jupyterbook.org/en/stable/customize/config.html html: - favicon: "figures/TB_favicon.ico" # Replace this with your own favicon, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) - baseurl: "https://.io/" # Replace this with your own URL, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) use_multitoc_numbering : true # Default value (line can be removed), sets continuous numbering across parts/chapters, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) extra_footer : "" # Default value (line can be removed), sets text to be displayed underneath the footer, configuration part of Jupyter Book (https://jupyterbook.org/en/stable/customize/config.html) @@ -30,6 +28,8 @@ sphinx: # Options passed on to the thebe_config: use_thebe_lite: true # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] #exclude files which should not be accessible for live code, configuration part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html) + html_favicon: "figures/TB_favicon.ico" # Replace this with your own favicon, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + html_baseurl: "https://.io/" # Replace this with your own URL, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) html_theme_options: logo: text: Template # Replace this with your own book title, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) @@ -51,6 +51,7 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } + bibtex_bibfiles: references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) @@ -94,9 +95,6 @@ teachbooks: attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) attribution_color: null # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) -bibtex_bibfiles: - - references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) - # Parse and render settings parse: myst_enable_extensions: # Default values (lines can be removed), sets extensions to enable in the myst parser, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html) From 0df4b0d61a01e343fe18fdce8efb42f810859a0b Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 18:24:05 +0200 Subject: [PATCH 14/19] Change bibtex_bibfiles to a list format --- book/_config.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index eba762b..8a6c779 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -51,7 +51,8 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } - bibtex_bibfiles: references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + bibtex_bibfiles: + - references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) From c5e28dae5214e9cde20648ee04dba9842eb194bb Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 18:25:38 +0200 Subject: [PATCH 15/19] Change bibtex_bibfiles format in config --- book/_config.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/book/_config.yml b/book/_config.yml index 8a6c779..ead7c1c 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -51,8 +51,7 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } - bibtex_bibfiles: - - references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + bibtex_bibfiles: "references.bib" # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) From 81afc603733e66bcf9e4e016c2d01f79a1bba38a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 18:27:57 +0200 Subject: [PATCH 16/19] Update _config.yml --- book/_config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index ead7c1c..3a8df7f 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -51,7 +51,7 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } - bibtex_bibfiles: "references.bib" # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + bibtex_bibfiles: "./references.bib" # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) From 4dbc469d11f4af189d08a73c7548bbf204630f6a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Sun, 14 Sep 2025 18:30:16 +0200 Subject: [PATCH 17/19] Move bibtex_bibfiles to a new format in config --- book/_config.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/book/_config.yml b/book/_config.yml index 3a8df7f..779ce4f 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -51,7 +51,6 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } - bibtex_bibfiles: "./references.bib" # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) @@ -95,6 +94,9 @@ teachbooks: attribution_location: top # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) attribution_color: null # Default value (line can be removed), uses blue colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html) +bibtex_bibfiles: + - references.bib # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) + # Parse and render settings parse: myst_enable_extensions: # Default values (lines can be removed), sets extensions to enable in the myst parser, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html) From 96055fed99bdaecf3d20fd29eea7600a0fe71b1a Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 17 Sep 2025 08:34:52 +0200 Subject: [PATCH 18/19] Update _config.yml --- book/_config.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/book/_config.yml b/book/_config.yml index 779ce4f..269ca9f 100644 --- a/book/_config.yml +++ b/book/_config.yml @@ -51,6 +51,7 @@ sphinx: # Options passed on to the chtml: { mtextInheritFont: true # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html) } + keep_warnings: false # Default value (line can be removed), disables showing warnings in the book, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-keep_warnings) patch_config: disabled-patches: [] # Default value (line can be removed), disables specific patches, configuration part of JupyterBook-Patches (https://teachbooks.io/manual/external/JupyterBook-Patches/README.html) inverter_all: true # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html) From 3451860f47ae16bbd52ecc8b8a321832eea00b21 Mon Sep 17 00:00:00 2001 From: Tom van Woudenberg Date: Wed, 17 Sep 2025 11:35:52 +0200 Subject: [PATCH 19/19] Correct line numbers in configuration instructions Updated line references for configuration in exercises. --- book/exercises/003.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/book/exercises/003.md b/book/exercises/003.md index a53e9a4..d3d3e2e 100644 --- a/book/exercises/003.md +++ b/book/exercises/003.md @@ -18,7 +18,7 @@ author: , built with TeachBooks a 3. In the `Edit` field, change the title of your homepage which will under the logo and above the table of contents ````{admonition} Need some help? :class: tip, dropdown -The 21st line of your `_config.yml` should look like +The 35th line of your `_config.yml` should look like ```yaml text: ``` @@ -26,7 +26,7 @@ The 21st line of your `_config.yml` should look like 4. In the `Edit` field, change the repository url which will be used to allow other people to open your repository, suggest edits and open issues as shown in top right corner of the built book under {octicon}`mark-github;1em`. ````{admonition} Need some help? :class: tip, dropdown -The 24th line of your `_config.yml` should look like +The 38th line of your `_config.yml` should look like ```yaml repository_url: "https://github.com//" ``` @@ -45,4 +45,4 @@ Before moving on to the next exercise, make sure you understand the following: - What is this special `_config.yml` file? - Changes in `_config.yml` can have effect on multiple pages in the book - The `_config.yml` is generally not used for adding content -``` \ No newline at end of file +```