Skip to content
Snippets Groups Projects
_config.yml 3.9 KiB
Newer Older
Manali Shah's avatar
Manali Shah committed
# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

#######################################################################################
# Book Settings
title: "\"How-To\" Manual"
author: TU Delft Applied Sciences OIT team
description: Manual for all the professors that want to publish their books with Jupyter books implementation.
copyright: Delft University of Technology, CC BY-SA 4.0
logo: content/images/tudelft.png
exclude_patterns: [ _build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints" ]
only_build_toc_files: true


#######################################################################################
# Execution settings
execute:
  execute_notebooks: force
  cache: ""
  exclude_patterns: [ ]
  timeout: 30
  run_in_temp: false
  allow_errors: false
  stderr_output: show


#######################################################################################
# Parse and render settings
parse:
  myst_enable_extensions:
    - amsmath
    - colon_fence # To allow for ::: instead of ``` blocks.
    - deflist
    - dollarmath
    - html_admonition
    - html_image
    - linkify
    - replacements
    - smartquotes
    - substitution
    - tasklist
  myst_url_schemes: [ mailto, http, https ]
  myst_dmath_double_inline: true


#######################################################################################
# HTML-specific settings
html:
  favicon: "content/images/favicon.ico"
  use_edit_page_button: true
  # use_repository_button: true -> moved downwards to be compatible with the darkmode TU delft logo
Manali Shah's avatar
Manali Shah committed
  use_issues_button: false
  use_multitoc_numbering: true
  extra_navbar: Powered by <a href="https://www.tudelft.nl/">TU Delft</a>
  extra_footer: ""
  google_analytics_id: ""
  home_page_in_navbar: true
  baseurl: ""
  comments:
    hypothesis: false
    utterances: false


#######################################################################################
# LaTeX-specific settings
latex:
  latex_engine: pdflatex
  use_jupyterbook_latex: true
  latex_documents:
    targetname: book.tex


#######################################################################################
# Launch button settings
launch_buttons:
  notebook_interface: classic


#######################################################################################
# Information about where the book exists on the web
repository:
  url: https://gitlab.tudelft.nl/opentextbooks/how-to-manual/
  path_to_book: ""
  branch: master


#######################################################################################
# Add a bibtex file so that we can create citations
bibtex_bibfiles:
  - references.bib


#######################################################################################
# Advanced and power-user settings
sphinx:
  extra_extensions:
    - sphinx_proof
    - sphinx_exercise
    - sphinx_togglebutton
    - sphinx_inline_tabs

  recursive_update: false

  config:
      repository_url: https://gitlab.tudelft.nl/opentextbooks/how-to-manual/
      use_repository_button: True
      announcement: "Under Development"

      logo:
        image_light: content/images/tudelft.png
        image_dark: content/images/tudelft-dark.png
Manali Shah's avatar
Manali Shah committed
    html_js_files:
      - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js
      - https://cdn.jsdelivr.net/npm/loading-attribute-polyfill@2.1.0/dist/loading-attribute-polyfill.min.js
      - https://cdn.jsdelivr.net/npm/loading-attribute-polyfill@2.1.0/dist/loading-attribute-polyfill.min.css
    mathjax3_config:
      loader: { load: [ '[tex]/autoload', '[tex]/ams' ] }
      tex:
        packages: { '[+]': [ 'autoload', 'ams', 'physics', 'boldsymbol' ] }
        tags: 'ams'
        macros:
          "kB": "k_\\mathrm{B}"
          "bm": "\\mathbf"
          "inprod": "\\innerproduct"
          "diff": "\\pdv"