-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_config.yml
152 lines (140 loc) · 8.13 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
#######################################################################################
# A default configuration that will be loaded for all jupyter books
# See the documentation for help and more options:
# https://jupyterbook.org/customize/config.html
#######################################################################################
# Book settings
# title : "Modèle de livre avec Jupyter Book" # The title of the book. Will be placed in the left navbar.
title : "Informatique en MP2I au lycée Kléber - 2021-2022" # The title of the book. Will be placed in the left navbar.
author : "Lilian Besson" # The author of the book
copyright : "2021-∞" # Copyright year to be placed in the footer
logo : logo.png # A path to the book logo
email : [email protected] # Email of the contact
description : "|:fr:| |:notebook:| |:snake:| Un modèle de livre avec Jupyter Book, et un livre exemple en français montrant les fonctionnalités géniales de Jupyter Book"
exclude_patterns : [venv3, .github, _build, LICENSE.txt, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"] # files/folders to be excluded
#######################################################################################
# Information about where the book exists on the web
repository:
url : https://github.com/Info-Prepas-MP2I/Modele-de-livre-avec-Jupyter-Book
# path_to_book: path/to/your/book # An optional path to your book, defaults to repo root
branch: main # An optional branch, defaults to `master`
#######################################################################################
# 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
myst_url_schemes : [mailto, http, https] # URI schemes that will be recognised as external URLs in Markdown links
#######################################################################################
# HTML-specific settings
html:
favicon : "" # A path to a favicon image
use_edit_page_button : true # Whether to add an "edit this page" button to pages. If `true`, repository information in repository: must be filled in
use_repository_button : true # Whether to add a link to your repository button
use_issues_button : true # Whether to add an "open an issue" button
extra_navbar : Généré manuellement par <a href="https://jupyterbook.org">Jupyter Book</a> # Will be displayed underneath the left navbar.
# Will be displayed underneath the footer.
extra_footer : |
<p>
Publié sous <a href="https://lbesson.mit-license.org/">licence libre MIT</a>.
</p>
# 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/
comments:
hypothesis : false
utterances : false
# TODO: activate utterances, when book is ready
# https://jupyterbook.org/interactive/comments/utterances.html
# utterances : true
#######################################################################################
# LaTeX-specific settings
latex:
latex_engine : pdflatex # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
latex_documents:
targetname: book.tex
title: "Modèle de livre avec Jupyter Book"
author: "Lilian Besson"
theme: "manual"
toctree_only: True
papersize: "a4paper"
pointsize: "10pt"
# fontpkg: "\\usepackage{tgpagella}"
#######################################################################################
# Launch button settings
# Configure your Binder links, such as the URL of the BinderHub.
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 : "" # 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)
# DONE: allow thebe, when Binder will work!
# TODO: how to make it work for non-Python kernel?
# https://jupyterbook.org/interactive/launchbuttons.html#live-interactive-pages-with-thebelab
colab_url : https://colab.research.google.com # The URL of Google Colab (https://colab.research.google.com)
only_build_toc_files : true # https://jupyterbook.org/customize/config.html#config-exclude-non-toc-files
# For GitHub pages, https://info-prepas-mp2i.github.io/Modele-de-livre-avec-Jupyter-Book/
# TODO: remove?
theme : jekyll-theme-slate
#######################################################################################
# Execution settings
execute:
execute_notebooks : auto # 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/`
# A list of patterns to *skip* in execution (e.g. a notebook that takes a really long time)
exclude_patterns :
- "notebooks/*Rust*ipynb"
- "notebooks/*C*ipynb"
- "notebooks/*Java*ipynb"
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 : true # 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'
#######################################################################################
# Advanced and power-user settings
# https://jupyterbook.org/customize/config.html#adding-extra-extensions
sphinx:
# https://github.com/sphinx-contrib/youtube
# https://sphinxcontrib-tikz.readthedocs.io/en/latest/
# https://sphinxcontrib-proof.readthedocs.io/en/latest/
# https://github.com/sphinx-contrib/emojicodes
# A list of extra extensions to load by Sphinx (added to those already used by JB).
extra_extensions:
- sphinx.ext.todo
# - sphinxcontrib.youtube, # FIXME: doesn't work so far!
- sphinxcontrib.tikz
- sphinxcontrib.proof
- sphinxemoji
local_extensions : # A list of local extensions to load by sphinx specified by "name: path" items
# key-value pairs to directly over-ride the Sphinx configuration
config:
# https://www.sphinx-doc.org/en/master/usage/extensions/todo.html
todo_include_todos: True
todo_emit_warnings: True
todo_link_only: True
html_last_updated_fmt: "%A %d %B %Y (à %Hh%M)"
latex_logo: 'logo.png'
latex_toplevel_sectioning: 'chapter'
# See https://github.com/miti-gt-donnees/guide/blob/master/_config.yml
# latex_elements:
# # preamble: |
# # \usepackage{}
# # maketitle: |
# # \newcommand\sphinxbackoftitlepage{\input{../../credits.tex}}\sphinxmaketitle
# https://jupyterbook.org/advanced/advanced.html#configuring-to-improve-accessibility
language: fr
mathjax_config:
TeX:
# https://jupyterbook.org/advanced/sphinx.html#defining-tex-macros
Macros:
"N": "\\mathbb{N}"
"floor": ["\\lfloor#1\\rfloor", 1]