_config.yml

#######################################################################################
# Book settings
title                       : "" # The title of the book. Will be placed in the left navbar.
author                      : ""  # The author of the book
logo                        : "./_static/cookbook-logo-small.png"  # A path to the book logo
exclude_patterns            : [.github/*, README.md, venv/*, node_modules/*, _content_not_in_toc/* ]  # Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")

#######################################################################################
# Execution settings
execute:
  execute_notebooks         : off  # 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)

#######################################################################################
# HTML-specific settings
html:
  favicon                   : "./_static/images/logo/favicon.ico"  # A path to a favicon image
  navbar_number_sections    : True  # Add a number to each section in your left navbar
  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
  home_page_in_navbar       : True  # Whether to include your home page in the left Navigation Bar
  baseurl                   : "https://fairplus.github.io/the-fair-cookbook"  # The base URL where your book will be hosted. Used for creating image previews and social links. e.g.: https://mypage.com/mybook/
  extra_navbar              : ""
  extra_footer              :  # Will be displayed underneath the footer.
    <script>
      mermaid.init()
    </script>
  google_analytics_id       : "UA-171697285-1"  # A GA id that can be used to track book views.
  comments:
    hypothesis: false
    # utterances:
    #   repo: "FAIRplus/the-fair-cookbook"
#######################################################################################
# Launch button settings
launch_buttons:
  notebook_interface        : "jupyterlab" # 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)
  thebelab                  : false  # Add a thebelab button to pages (requires the repository to run on Binder)
  colab_url                 : "https://colab.research.google.com"

repository:
  url                       : https://github.com/FAIRplus/the-fair-cookbook  # The URL to your book's repository
  path_to_book              : ""  # A path to your book's folder, relative to the repository root.
  branch                    : migrating  # Which branch of the repository should be used when creating links

#######################################################################################
# Advanced and power-user settings 
# sphinx:
#   config:
#     html_baseurl: 'https://path_to_book/'
#   extra_extensions:
#     - sphinx_sitemap 
sphinx:
   # - sphinx_tabs.tabs
  config                    : # key-value pairs to directly over-ride the Sphinx configuration
    templates_path          : ['_templates']
    html_extra_path         : ["_inject_after_build"]
    html_baseurl            : 'https://fairplus.github.io/the-fair-cookbook'
#    html_theme_options: {
#      "search_bar_text": "Search for FAIR recipes (^_^) "
#    }

  extra_extensions:   # A list of extra extensions to load by Sphinx.
    - sphinx_sitemap
    - sphinxcontrib.youtube
  local_extensions:
    authors_fairplus: _ext/
    figure_fairplus: _ext/
    license_fairplus: _ext/
    panels_fairplus: _ext/

parse:
  myst_url_schemes: [ mailto, http, https, ftp ]

bibtex_bibfiles:
   - ./_bibliography/bibliography-faircookbook.bib

bibtex_reference_style: author_year