forked from enze-chen/mi-book-2022
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy path_config.yml
91 lines (70 loc) · 3.99 KB
/
_config.yml
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
39
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
# Book settings. Learn more at https://jupyterbook.org/customize/config.html
title : Introduction to Materials Informatics
author : Enze Chen and Mark Asta
copyright : "2022"
logo : mi_logo.png # logo in top-left corner
only_build_toc_files : true # whether to ignore the extra files
exclude_patterns : ["README.md", "LICENSE.md", "**_master.ipynb"]
#######################################################################################
# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks : cache # 'auto,' 'cache,' or 'force'
timeout : 300 # max seconds for notebook to execute
allow_errors : true # whether to allow and show errors
#######################################################################################
# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
use_edit_page_button : true # button for users to edit page and submit a PR.
use_issues_button : true # button for users to submit a GitHub issue
use_repository_button : true # button for users to look at the source code in GitHub repo
favicon : "mi_favicon.png" # the icon in the browser tab
baseurl : https://enze-chen.github.io/mi-book-2022 # The base URL where the book is hosted
extra_footer : |
<a rel="license" href="http://creativecommons.org/licenses/by-sa/4.0/">
<img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png" />
</a>
google_analytics_id : UA-197730750-1
home_page_in_navbar : true
#######################################################################################
# Launch button settings
launch_buttons:
notebook_interface : classic
binderhub_url : ""
colab_url : https://colab.research.google.com
jupyterhub_url : https://datahub.berkeley.edu
thebe : false
# Information about where the book exists on the web
repository:
url : https://github.com/enze-chen/mi-book-2022
path_to_book : ""
branch : master # source branch
#######################################################################################
# Parse and render settings
parse:
myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
- amsmath # LaTeX math
- colon_fence # cleaner directives
- dollarmath # in-line LaTeX
- linkify # auto-detect HTML-like links
- smartquotes # transforms quotes and dashes
- substitution # allows variable/dictionary substitution
myst_url_schemes : [mailto, http, https] # URI schemes that will be recognised as external URLs in Markdown links
#######################################################################################
# Define the name of the latex output file for PDF builds
latex:
latex_engine : pdflatex
latex_documents:
targetname : book.tex
# Add a bibtex file so that we can create citations
bibtex_bibfiles : ["assets/files/references.bib"]
#######################################################################################
# Advanced and power-user settings
sphinx:
config:
language : en # include explicitly for accessibility
mathjax_path : https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js # faster by 60-80%
html_extra_path : ["assets"]
html_js_files : https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
bibtex_default_style : plain