/
_config.yml
93 lines (84 loc) · 5.22 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
92
93
#######################################################################################
# A default configuration that will be loaded for all jupyter books
# Users are expected to override these values in their own `_config.yml` file.
# This is also the "master list" of all allowed keys and values.
#######################################################################################
# Book settings
title: DemARK # The title of the book. Will be placed in the left navbar.
author: The Econ-ARK Team # The author of the book
copyright: "2023" # Copyright year to be placed in the footer
logo: econ-ark-logo.png # A path to the book logo
# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
exclude_patterns: [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"]
# Auto-exclude files not in the toc
only_build_toc_files: false
#######################################################################################
# Execution settings
execute:
execute_notebooks: off # Whether to execute notebooks at build time. Must be one of ("auto", "force", "cache", "off")
cache: "" # A path to the jupyter cache that will be used to store execution artifacts. Defaults to `_build/.jupyter_cache/`
exclude_patterns: [] # A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
timeout: 30 # The maximum time (in seconds) each notebook cell is allowed to run.
run_in_temp:
false # If `True`, then a temporary directory will be created and used as the command working directory (cwd),
# otherwise the notebook's parent directory will be the cwd.
allow_errors: false # If `False`, when a code cell raises an error the execution is stopped, otherwise all cells are always run.
stderr_output: show # One of 'show', 'remove', 'remove-warn', 'warn', 'error', 'severe'
#######################################################################################
# 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
- colon_fence
# - deflist
- dollarmath
# - html_admonition
# - html_image
- linkify
# - replacements
# - smartquotes
- substitution
- tasklist
myst_url_schemes: [mailto, http, https] # URI schemes that will be recognised as external URLs in Markdown links
myst_dmath_double_inline: true # Allow display math ($$) within an inline context
#######################################################################################
# HTML-specific settings
html:
favicon: econ-ark-logo-small.png # A path to a favicon image
use_edit_page_button: false # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
use_repository_button: false # Whether to add a link to your repository button
use_issues_button: false # Whether to add an "open an issue" button
use_multitoc_numbering: true # Continuous numbering across parts/chapters
extra_footer: "" # Will be displayed underneath the footer.
google_analytics_id: "" # A GA id that can be used to track book views.
home_page_in_navbar: true # Whether to include your home page in the left Navigation Bar
baseurl: "" # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
analytics:
comments:
hypothesis: false
utterances: false
announcement: "" # A banner announcement at the top of the site.
#######################################################################################
# LaTeX-specific settings
latex:
latex_engine: pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
use_jupyterbook_latex: true # use sphinx-jupyterbook-latex for pdf builds as default
#######################################################################################
# Launch button settings
launch_buttons:
notebook_interface: jupyterlab # The interface interactive links will activate ["classic", "jupyterlab"]
binderhub_url: "https://mybinder.org" # The URL of the BinderHub (e.g., https://mybinder.org)
jupyterhub_url: "https://hub.econ-ark.org/" # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
thebe: true # Add a thebe button to pages (requires the repository to run on Binder)
colab_url: "https://colab.research.google.com" # The URL of Google Colab (https://colab.research.google.com)
repository:
url: https://github.com/econ-ark/DemARK # The URL to your book's repository
path_to_book: "" # A path to your book's folder, relative to the repository root.
branch: master # Which branch of the repository should be used when creating links
#######################################################################################
# Advanced and power-user settings
sphinx:
extra_extensions: # A list of extra extensions to load by Sphinx (added to those already used by JB).
local_extensions: # A list of local extensions to load by sphinx specified by "name: path" items
recursive_update: false # A boolean indicating whether to overwrite the Sphinx config (true) or recursively update (false)
config: # key-value pairs to directly over-ride the Sphinx configuration