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

Update _config.yml

Browse source
This commit is contained in:
Tom van Woudenberg 2025-03-21 12:19:28 +01:00 • committed by GitHub
parent 9121c18a7d
commit 0ce05e4b6f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 33 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

37
book/_config.yml
View file

@ -1,36 +1,37 @@
title: TeachBooks template # Replace this with your own book title title: TeachBooks template # Replace this with your own book title
author: TeachBooks Team, built with <a href="https://teachbooks.io">TeachBooks</a> and <a href="https://jupyterbook.org/">Jupyter Book</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a> #add your own name here author: TeachBooks Team, built with <a href="https://teachbooks.io">TeachBooks</a> and <a href="https://jupyterbook.org/">Jupyter Book</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a>
# Replace TeachBooks Teams with your own name in the line above
execute: 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
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 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
sphinx: sphinx: # Options passed on to the underlying sphinx-parser
config: config:
html_js_files: 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: https://teachbooks.io/manual/features/live_code.html
thebe_config: thebe_config:
use_thebe_lite: true #required for live code: https://teachbooks.io/manual/features/live_code.html 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 exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] #exclude files which should not be accessible for live code: https://teachbooks.io/manual/features/live_code.html
html_theme_options: html_theme_options:
logo: logo:
text: Template # Replace this with your own book title 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_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) 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 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) 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) 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_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_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) 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: launch_buttons:
thebe: true #required for live code: https://teachbooks.io/manual/features/live_code.html thebe: true # Required for live code: https://teachbooks.io/manual/features/live_code.html
favicon : "figures/TB_favicon.ico" #replace this with your own favicon favicon : "figures/TB_favicon.ico" # Replace this with your own favicon
baseurl : "https://teachbooks.io/" # Replace this with your own URL baseurl : "https://teachbooks.io/" # Replace this with your own URL
html_show_copyright: false #as the copyright is included in the author field 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_last_updated_fmt: '%B %-d, %Y' # Adds the date of the last update to the footer
html_static_path: ["figures"] # add folders that contain files that need to be included, such as the location of the logo(s) html_static_path: ["figures"] # Add folder that contain files that need to be included, such as the location of the logo(s)
mathjax3_config: mathjax3_config:
chtml: { chtml: {
mtextInheritFont: true # To typeset text within math prettier mtextInheritFont: true # To typeset text within math prettier
@ -45,4 +46,4 @@ sphinx:
- sphinx_named_colors # Allows you to use custom colors in your book https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html - sphinx_named_colors # Allows you to use custom colors in your book https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html
bibtex_bibfiles: bibtex_bibfiles:
- references.bib #required for references - references.bib # Required for references