_config.yml

#######################################################################################
# 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                       : "Multi-Echo fMRI Data Analysis"  # The title of the book. Will be placed in the left navbar.
author                      : "The tedana community"  # The author of the book
copyright                   : "2021"  # Copyright year to be placed in the footer
logo                        : "logo.png"  # A path to the book logo
exclude_patterns            : ["README.md", "content/*.py"]  # Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")

#######################################################################################
# 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 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)
  timeout                   : -1  # remove restriction on execution time

#######################################################################################
# HTML-specific settings
html:
  favicon                   : ""  # A path to a favicon image
  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     : true  # 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/
  comments:
    hypothesis              : true

#######################################################################################
# LaTeX-specific settings
latex:
  latex_engine              : pdflatex  # one of 'pdflatex', 'xelatex' (recommended for unicode), 'luatex', 'platex', 'uplatex'
  use_jupyterbook_latex     : true # use sphinx-jupyterbook-latex for pdf builds as default

#######################################################################################
# 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)
  thebe                     : false  # Add a thebe button to pages (requires the repository to run on Binder)

repository:
  url                       : https://github.com/ME-ICA/multi-echo-data-analysis  # The URL to your book's repository
  path_to_book              : "content"  # 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

#######################################################################################
# Additional configuration info
bibtex_bibfiles:
  - content/references.bib
sphinx:
  extra_extensions:
  - sphinx_inline_tabs
  - sphinx_jupyterbook_latex
  - sphinx_proof
  - sphinxcontrib.bibtex
  config:
    bibtex_reference_style: author_year
    bibtex_default_style: unsrt
    html_js_files:
    - https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js
    intersphinx_mapping:
      tedana:
      - "https://tedana.readthedocs.io/en/0.0.11/"
      - null
    language: en