template/book/_config.yml

# This config includes an opinionated list of configuration options of TeachBooks, Jupyterbook v1, Sphinx and other extensions part of TeachBooks-Favourites.

title: "My TeachBook title"                          # Replace with your own book title shown in browser tab, configuratin part of JupyterBook: https://jupyterbook.org/en/stable/customize/config.html
author: TeachBooks Team, built with <a href="https://teachbooks.io">TeachBooks</a>, <a href="https://creativecommons.org/licenses/by/4.0/" target="_blank" rel="license noopener noreferrer"">CC BY 4.0<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg" alt=""></a>
                                                     # Replace TeachBooks Teams with your own name in the line above, configuratin part of JupyterBook: https://jupyterbook.org/en/stable/customize/config.html
execute:
  execute_notebooks: "off"                           # Replace this if you want don't have notebooks with output and you want to add notebook output during build, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
  exclude_patterns:  []                              # Default value (line can be removed), sets a list of patterns to *skip* in execution, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html), can overwritten by Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html)
  timeout:           30                              # Default value (line can be removed), sets he maximum time (in seconds) each notebook cell is allowed to run, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
  allow_errors:      false                           # Default value (line can be removed), all cells are always run, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)

html:
  use_multitoc_numbering    : true                  # Default value (line can be removed), sets continuous numbering across parts/chapters, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html). Same functionality per section can be defined with sphinx-external-toc (https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)

sphinx:                                              # Options passed on to the underlying sphinx-parser
  extra_extensions:                                  # Sets a list of extensions to load by sphinx, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
    - teachbooks_favourites                          # Gives you a starter package of extensions to use in your book, replace with individual extensions if you prefer some extensions not to be included (https://github.com/TeachBooks/TeachBooks-Favourites)
  config:
    language: en                                     # Defines language (English) of everything except the content itself. For Dutch: replace with `nl`, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
    html_js_files:
    - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html)
    thebe_config:
      use_thebe_lite: true                           # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html)
      exclude_patterns: ["**/_*.yml", "**/*.md", "**/*.ipynb"] #exclude files which should not be accessible for live code, configuration part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html)
    html_favicon: "figures/TB_favicon.ico"           # Replace this with your own favicon, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
    html_baseurl:  "https://<user/org>.io/<repo>"    # Replace this with your own URL, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
    html_theme_options:
      home_page_in_toc: true                         # Replace with false it you don't want the landing page to be shown in the table of contents.
      logo:
        text:        Template                        # Replace this with your own book title, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
        image_light: TeachBooks_logo.svg             # Put your logo for the light mode here (can be the same as image_dark), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
        image_dark:  TeachBooks_logo_inverted.svg    # Put your logo for the dark mode here (can be the same as image_light), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
      repository_url: "https://github.com/user/repo" # Add your own repo URL here, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
      path_to_docs:          "book"                  # Required for edit_page_button, should be book if you're using TeachBooks package (https://github.com/TeachBooks/TeachBooks) or the TeachBooks deploy book workflow (https://teachbooks.io/manual/external/deploy-book-workflow/README.html), configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
      repository_branch:     "main"                  # Replace when you change the name of your published branch (required for edit_page_button), configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
      use_edit_page_button:  true                    # Replace with false if you don't want the edit page button (i.e. if you don't user to propose changes themselves or have a private repo), configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
      use_repository_button: true                    # Replace with false if you don't want the repository button (i.e. if you have a private repo), configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
      use_issues_button :    true                    # Replace with false if you don't want the issues button (i.e. if you don't want to use GitHub issues or have a private repo), configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
      launch_buttons:
        thebe: true                                  # Required for live code, part of TeachBooks-Sphinx-Thebe (https://teachbooks.io/manual/features/live_code.html)
      announcement: ""                               # Default value (line can be removed), sets a banner announcement at the top of the site, configuration part of Jupyterbook v1 (https://jupyterbook.org/en/stable/customize/config.html)
    html_show_copyright:   false                     # As the copyright is included in the author field, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
    html_last_updated_fmt: ''                        # Adds the date of the last update to the footer, if '' based on value of language, configuration part of sphinx-last-updated-by-git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
    html_static_path: ["figures"]                    # Add folder that contain files that need to be included, such as the location of the logo(s), configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
    mathjax3_config:
      chtml: {
        mtextInheritFont: true                       # To typeset text within math prettier, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)
      }
    keep_warnings: false                             # Default value (line can be removed), disables showing warnings in the book, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-keep_warnings)
    nitpicky: true                                   # Enables warnings for all references where the target cannot be found, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-nitpicky)
    myst_enable_extensions:                          # Default values (lines can be removed), sets extensions to enable in the myst parser, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html)
      - attrs_block
      - attrs_inline
      - colon_fence
      - deflist
      - dollarmath
      - fieldlist
      - html_image
      - linkify
      - substitution
      - tasklist
      - smartquotes
      - strikethrough
      - replacements
    myst_url_schemes: [mailto, http, https]          # Default value (lines can be removed), sets URI schemes that will be recognised as external URLs in Markdown links, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/syntax/optional.html)
    myst_links_external_new_tab: true                # Opens all eternal links in a new tab, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/configuration.html)
    myst_number_code_blocks: []                      # Default value (lines can be removed), add line numbers to code blocks with these languages, configuration part of MyST parser (https://myst-parser.readthedocs.io/en/latest/configuration.html)
    myst_substitutions: {}                           # Default value (lines can be removed), sets no substitutions, configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.html
    myst_dmath_double_inline: true                   # Parse inline `$$ ... $$`, configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.html
    myst_enable_checkboxes: false                    # Default value (lines can be removed), disables checkboxes, configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.html
    myst_linkify_fuzzy_links: false                  # Disables automatic hyperlink creation for fuzzy links without schemes like https:// , configuration part of https://myst-parser.readthedocs.io/en/latest/configuration.htmlhtml#confval-nitpicky)
    external_toc_exclude_missing: true               # Replace this with false if you want to build all files in the book, allowing you to refer to pages which are not included in the table of contents, configuration part of jupyterbook, configuration part of sphinx-external-toc (https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
    external_toc_path: "_toc.yml"                    # Default value (line can be removed), sets path to the table of contents file, configuration part of sphinx-external-toc (https://sphinx-external-toc.readthedocs.io/en/latest/intro.html)
    inverter_all:        true                        # Default value (line can be removed), inverts all figures, configuration part of Sphinx-Image-Inverter (https://teachbooks.io/manual/external/Sphinx-Image-Inverter/README.html)
    iframe_blend:          true                      # Default value (line can be removed), blends all iframes with the background and in dark-mode also inverted., configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html)
    iframe_aspectratio:    auto 2 / 1                # Default value (line can be removed), sets the standard aspect ration of the iframe within the parent element, configuration part of Sphinx-Iframes (https://teachbooks.io/manual/external/sphinx-iframes/README.html)
    hide_solutions: false                            # Default value (line can be removed), does not hide all solutions from exercises, configuration part of Sphinx-Exercise (https://ebp-sphinx-exercise.readthedocs.io/en/latest/syntax.html#remove-all-solutions)
    exercise_style: ""                               # Default value (line can be removed), does not simplify solution titles (simplified are useful when solutions directly follow exercises), configuration part of Sphinx-Exercise (https://ebp-sphinx-exercise.readthedocs.io/en/latest/syntax.html#solution-title-styling)
    named_colors_custom_colors: {'attributiongrey':[150,150,150]} # Defines grey colour for attribution boxes, configuration part of Sphinx-Named-Colors (https://teachbooks.io/manual/external/Sphinx-Named-Colors/README.html)
    proof_minimal_theme: false                       # Default value (line can be removed), uses default color scheme for admonitions part of sphinx-proof, configuration part of Sphinx-Proof (https://sphinx-proof.readthedocs.io/en/latest/options.html)
    sphinx_codex_name:                 ""            # Default value (line can be removed), uses default 'Code example' as title for codex directives, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html)
    sphinx_codex_style_from_proof:     true          # Default value (line can be removed), the CSS color style of the codex directive will be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html)
    sphinx_codex_icon_from_proof:      false         # Default value (line can be removed), the icon of the codex directive will not be taken from the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html)
    sphinx_codex_merge_with_proof:     false         # Default value (line can be removed), the codex directive will not be merged with the prf:example directive from the sphinx-proof extension, configuration part of Sphinx-Code-Examples (https://teachbooks.io/manual/_git/github.com_TeachBooks_sphinx-code-examples/main/MANUAL.html)
    nb_execution_includepatterns: []                 # Default value (line can be removed), sets a a list of glob patterns to indicate notebooks that must be included for execution, configuration part of Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html)
    nb_execution_patterns_method: "only_include"     # Default value (line can be removed), sets the method used when both include and exclude patterns are provided, configuration part of Sphinx-NB-Execution-Patterns (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-NB-Execution-Patterns/Manual/README.html)
    #tippy_skip_urls                                 # Default value not shown (line can be removed), a list of URL regexes to skip, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
    tippy_tip_selector: "figure, table, img, p, aside, div.admonition, div.literal-block-wrapper" # Default value (line can be removed), defines what elements tips are created for, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
    tippy_enable_wikitips:        true               # Default value (line can be removed), enables tooltips for wikipedia links, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
    tippy_enable_doitips:         true               # Default value (line can be removed), enables tooltips for DOI links, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
    #tippy_custom_tips                               # Default value not shown (line can be removed), creates custom tips, configuration part of TeachBooks-Sphinx-Tippy (https://teachbooks.io/manual/external/teachbooks-sphinx-tippy/README.html)
    metadata_figure_settings:                        # Default values (lines can be removed), configuration options for Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
      style: 
        placement: hide                              # Default value (line can be removed), hide the metadata, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        show: author,license,date,copyright,source   # Default value (line can be removed), defines metadata to be shown if placement is not set to hide, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        admonition_title: Attribution                # Default value (line can be removed), title of admonition if placement is set to admonition, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        admonition_class: attribution                # Default value (line can be removed), CSS class of admonition if placement is set to admonition, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
      license:
        link_license: true                           # Default value (line can be removed), converts license to link, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        strict_check: false                          # Default value (line can be removed), doesn't raise an error when license infromation is missing or invalid, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        summaries: false                             # Default value (line can be removed), doesn't show a summary of invalid or missing licenses, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        individual: false                            # Default value (line can be removed), doesn't show individual warnings of invalid or missing licenses, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        substitute_missing: false                    # Default value (line can be removed), doesn't substitute missing license with default license, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        default_license: CC-BY                       # Default value (line can be removed), sets default license to CC BY, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
      author:
        substitute_missing: false                    # Default value (line can be removed), doesn't substitue missing author with default author, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        default_author: config                       # Default value (line can be removed), sets default author to author in config.yml, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
      date:
        substitute_missing: false                    # Default value (line can be removed), doesn't substitue missing date with default date, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        default_date: today                          # Default value (line can be removed), sets default data to date of build, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
      copyright:
        substitute_missing: false                    # Default value (line can be removed), doesn't substitue missing copyright with default copyright, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
        default_copyright: authoryear                # Default value (line can be removed), sets default copyright to author and year, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
      source:
        warn_missing: false                          # Default value (line can be removed), doesn't raise a warning for missing sources, configuration part of Sphinx Metadata Figure (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Metadata-Figure/main/MANUAL.html)
    git_untracked_check_dependencies: false          # Doesn't check date of dependencies if file is not tracked by git (yet), configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
    git_untracked_show_sourcelink: true              # Keeps sourcefiles in book when it is not tracked by git (yet), configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
    git_last_updated_timezone: 'Europe/Amsterdam'    # Sets local timezone for last updated date, otherwise uses local time zone of build, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
    git_exclude_patterns: []                         # Default value (line can be removed), sets a list of patterns to *skip* in git last updated date checking, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
    git_exclude_commits: []                          # Default value (line can be removed), sets a list of commit hashes to *skip* in git last updated date checking, configuration part of Sphinx-Last-Updated-by-Git (https://github.com/TeachBooks/sphinx-last-updated-by-git)
    sphinx_gated_directives:
      override_existing: true                        # Override existing gated directives with the same name, configuration part of Sphinx-GitHub-Alerts (https://teachbooks.io/manual/_git/github.com_TeachBooks_Sphinx-Gated-Directives/main/MANUAL.html)
    nb_render_image_options: {}                      # Default value (line can be removed), options for image outputs, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
    nb_render_figure_options: {}                     # Default value (line can be removed), options for figure outputs, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
    nb_scroll_outputs: false                         # Default value (line can be removed), make long cell outputs not scrollable, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
    nb_remove_code_source: false                     # Default value (line can be removed), do not remove code cell source, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
    nb_remove_code_outputs: false                    # Default value (line can be removed), do not remove code cell outputs, configuration part of Myst-NB (https://myst-nb.readthedocs.io/en/latest/configuration.html)
    zoomies_selector: ".bd-article img"              # Default value (line can be removed), sets images that should be zoomable, configuration part of TeachBooks-Zoomies (https://github.com/TeachBooks/TeachBooks-Zoomies)
    zoomies_best_fit: 70                             # Default value (line can be removed), sets initial zoom level in the zomoable view, configuration part of TeachBooks-Zoomies (https://github.com/TeachBooks/TeachBooks-Zoomies)
    zoomies_toolbar: ["zoomIn", "zoomOut", "oneToOne", "reset"] # Default value (line can be removed), tools to show in the zoomable view, configuration part of TeachBooks-Zoomies (https://github.com/TeachBooks/TeachBooks-Zoomies)
    zoomies_invert_colors: false                     # Default value (line can be removed), disables inversion of colours in the zoomable view as this functionality is provided by Shpinx-Image-Inverter, configuration part of TeachBooks-Zoomies (https://github.com/TeachBooks/TeachBooks-Zoomies)
    zoomies_bg_apply_to_img: true                    # Default value (line can be removed), adds a background/padding directly to the image in the zoomable view., configuration part of TeachBooks-Zoomies (https://github.com/TeachBooks/TeachBooks-Zoomies)
    todo_include_todos: true                         # Enables to dos in documentation, configuration part of sphinx.ext.todo (https://www.sphinx-doc.org/en/master/usage/extensions/todo.html)
    teachbooks_questions:                            # Default values (lines can be removed), sets default feedback and number of columns for interactive questions, configuration part of TeachBooks-Questions (https://github.com/TeachBooks/TeachBooks-Questions)
      feedbacks:
        multiple-choice:
          single-select:
            true: ["Correct!"]
            false: ["Incorrect."]
          multiple-select:
            true: ["Correct!"]
            false: ["Incorrect."]
            correct: ["Well done!"]
            incorrect : ["Try again! You selected at least one incorrect option."]
            missed: ["Try again! You missed at least one correct option."]
            incorrect-missed: ["Try again! You selected at least one incorrect option and missed at least one correct option."]
        short-answer:
          blocks:
            true: ["Correct!"]
            false: ["Incorrect."]
          gaps:
            true: ["Correct!"]
            false: ["Incorrect."]
            correct: ["You filled in all gaps correctly."]
            incorrect: ["You filled in none of the gaps correctly."]
            mixed: ["You filled in some gaps correctly, but also some incorrectly."]
            show-answer: ["The correct answers are shown above."]
      columns:
        multiple-choice:
          single-select: "1 1 2 2"
          multiple-select: "1 1 2 2"
        short-answer:
          blocks: "1 1 1 1"
          gaps: "1 1 1 1"
        no-input:
          no-submit: "1 1 1 1"


teachbooks:
  attribution_location: top                          # Default value (line can be removed), sets location of attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html)
  attribution_color: attributiongrey                 # Uses custom grey colour for attribution admonition of external pages, configuration part of TeachBooks package (https://teachbooks.io/manual/features/external_toc.html)

bibtex_bibfiles: 
  - references.bib                                   # Required for references, configuration part of Sphinx (https://www.sphinx-doc.org/en/master/index.html)