-
Notifications
You must be signed in to change notification settings - Fork 1
/
_config.yml
62 lines (56 loc) · 4.02 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
######################################################################################
# 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 : C/C++ Primer # The title of the book. Will be placed in the left navbar.
author : Imperial College London # The author of the book
copyright : "2021-24" # Copyright year to be placed in the footer
logo : "images/Ada_Lovelace.jpg" # A path to the book logo
exclude_patterns : [] # Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
#######################################################################################
# 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 artifacs. 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)
#######################################################################################
# HTML-specific settings
html:
favicon : "" # A path to a favicon image
navbar_number_sections : False # Add a number to each section in your left navbar
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 : true # Whether to add an "open an issue" button
extra_navbar : Powered by <a href="https://jupyterbook.org">Jupyter Book</a> # Will be displayed underneath the left navbar.
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/
#######################################################################################
# Launch button settings
launch_buttons:
notebook_interface : classic # 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://jhub-stage.ese.ic.ac.uk/hub/presessional" # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
thebelab : false # Add a thebelab button to pages (requires the repository to run on Binder)
repository:
url : https://github.com/ese-msc/c-primer # The URL to your book's repository
path_to_book : "." # A path to your book's folder, relative to the repository root.
branch : main # 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.
- sphinx_thebe
config : # key-value pairs to directly over-ride the Sphinx configuration
thebe_config:
"repository_url": "https://github.com/ese-msc/c-primer"
"repository_branch": "main"
"selector": ".cell"
"selector_input": ".cell_input div.highlight"
"selector_output": ".cell_input div.highlight"
myst_enable_extensions:
- dollarmath
- substitution