mirror of
https://github.com/TeachBooks/template.git
synced 2026-11-12 22:25:52 +00:00
51 lines
2.1 KiB
YAML
51 lines
2.1 KiB
YAML
Title: TeachBooks template
|
|
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
|
|
|
|
execute:
|
|
execute_notebooks: "off"
|
|
|
|
only_build_toc_files: true
|
|
|
|
html:
|
|
favicon : "figures/TB_favicon.ico"
|
|
baseurl : "https://teachbooks.io/" #Replace this with your own URL
|
|
|
|
sphinx:
|
|
config:
|
|
html_js_files:
|
|
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
|
|
thebe_config:
|
|
use_thebe_lite: true
|
|
exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"]
|
|
html_theme_options:
|
|
logo:
|
|
text: Template
|
|
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"
|
|
repository_branch: "main"
|
|
use_edit_page_button: true
|
|
use_repository_button: true
|
|
use_issues_button : true
|
|
launch_buttons:
|
|
thebe: true
|
|
html_show_copyright: false
|
|
html_last_updated_fmt: '%B %-d, %Y'
|
|
html_static_path: ["figures"] # add folders that contain files that need to be included, such as the location of the logo(s)
|
|
mathjax3_config:
|
|
chtml: {
|
|
mtextInheritFont: true # To typeset text within math prettier
|
|
}
|
|
extra_extensions:
|
|
- sphinx.ext.imgconverter
|
|
- jupyterbook_patches
|
|
- download_link_replacer
|
|
- sphinx.ext.extlinks
|
|
- sphinx_image_inverter
|
|
- sphinx_iframes
|
|
- sphinx_exercise
|
|
- teachbooks_sphinx_tippy
|
|
|
|
bibtex_bibfiles:
|
|
- references.bib
|