Newer
Older
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html
title: Open textbooks demonstration
author: Timon Idema
logo: tudelft.png
description: Demonstration of what can be done with a Jupyter Book. This book is meant as a template to build on.
copyright: Delft University of Technology, CC BY-SA 4.0
# Only build files in the ToC to avoid building README, etc.
only_build_toc_files: true
# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
execute_notebooks: force
# Define the name of the latex output file for PDF builds
latex:
latex_documents:
targetname: book.tex
# Add a bibtex file so that we can create citations
bibtex_bibfiles:
- references.bib
# Sphinx, for html formatting. Needs checking version.
# Mathjax config allows us to define tex macros. Note that we need to escape the \ in a latex math command with an extra \.
sphinx:
config:
html_js_files:
- https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
mathjax3_config:
tex:
macros:
"kB" : "k_\\mathrm{B}"
# extra_extensions:
# - sphinx_proof
# - sphinx_exercise
# - sphinx_tojupyter
# Parse, for processing LaTeX-style math. See https://jupyterbook.org/en/stable/content/math.html#latex-style-math and https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#syntax-amsmath
parse:
myst_enable_extensions:
# don't forget to list any other extensions you want enabled,
# including those that are enabled by default!
# meaning that we have to explicitly include dollarmath!
- amsmath
- dollarmath
# Information about where the book exists on the web
repository:
url: https://gitlab.tudelft.nl/opentextbooks/open-textbooks-demonstration/ # Online location of your book
# path_to_book: docs # Optional path to your book, relative to the repository root
branch: master # Which branch of the repository should be used when creating links (optional)
# Add GitHub / GitLab buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
use_issues_button: true
use_repository_button: true
comments:
hypothesis: true # Hypothesis for comments