_config.yml

# Book settings
# Learn more at https://jupyterbook.org/customize/config.html

title: Pythia Foundations
author: the <a href="https://projectpythia.org/">Project Pythia</a> Community
logo: images/logos/pythia_logo-white-rtext.svg
email: projectpythia@ucar.edu
copyright: "2024"

exclude_patterns:
  - README.md
  - CONTRIBUTING.md

execute:
  # See https://jupyterbook.org/content/execute.html
  execute_notebooks: force
  #   "auto" should only execute those notebooks that don't have output in all cells.
  #   "force" : force execution of all notebooks
  #   "cache": Cache output of notebooks on each build.
  timeout: 600
  # Cells that are expected to fail (for pedagogical reasons) should set the cell tag `raises-exceptions`
  allow_errors: False

#######################################################################################
# Parse and render settings
parse:
  myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst-parser.readthedocs.io/en/latest/using/syntax-optional.html
    - amsmath
    - colon_fence
    - deflist
    - dollarmath
    - html_admonition
    - html_image
    - replacements
    - smartquotes
    - substitution

# 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

# WARNING:
# All of the remaining settings have been moved to the sphinx: config: ...
# section below.  This is because anything you set in the sphinx: config: ...
# section will overwrite (without recursive updating) any Sphinx config setting
# created by Jupyter Book.  For example, the `html_theme_options` Sphinx config
# setting gets replaced entirely by what is found in the sphinx: config: ...
# section below.  Thus, to use the new theme, all of these setting need to be
# set in the sphinx: config: ... section below.
#
# see: https://github.com/ProjectPythia/pythia-foundations/pull/196
#      https://github.com/executablebooks/jupyter-book/issues/1588

# Information about where the book exists on the web
# repository:
#   url: https://github.com/ProjectPythia/pythia-foundations # Online location of your book
#   #path_to_book: docs  # Optional path to your book, relative to the repository root
#   branch: main # Which branch of the repository should be used when creating links (optional)

# Configure your Binder links, such as the URL of the BinderHub.
# launch_buttons:
#   binderhub_url: https://mybinder.org
#   notebook_interface: jupyterlab

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
# html:
#   favicon: images/icons/favicon.ico
#   google_analytics_id: 'G-G57FLM9M46'
#   home_page_in_navbar: true
#   use_issues_button: true
#   use_repository_button: true
#   use_edit_page_button: true
#   extra_footer: |
#     <img src="/_static/footer-logo-nsf.png" style="float:left;width:60px;height:60px;margin-right:1rem;">
#     This material is based upon work supported by the National
#     Science Foundation under Grant Nos. 2026863 and 2026899. Any
#     opinions, findings, and conclusions or recommendations expressed
#     in this material are those of the author(s) and do not necessarily
#     reflect the views of the National Science Foundation.<br><br>
#     Theme by <a href="https://projectpythia.org">Project Pythia</a>.<br>
#     All code in Pythia Foundations is licensed under Apache 2.0. All other non-code content is licensed
#     under <a href="https://creativecommons.org/licenses/by/4.0/">Creative Commons BY 4.0 (CC BY 4.0)</a>.

sphinx:
  config:
    nb_execution_raise_on_error: true # raise exception in build if there are notebook errors (this flag is ignored if building on binder)
    linkcheck_request_headers:
      "https://docs.github.com/":
        User-Agent: Mozilla/5.0 (X11; Ubuntu; Linux i686; rv:24.0) Gecko/20100101 Firefox/24.0
    html_favicon: images/icons/favicon.ico
    html_last_updated_fmt: "%-d %B %Y"
    html_theme: sphinx_pythia_theme
    html_permalinks_icon: '<i class="fas fa-link"></i>'
    html_theme_options:
      analytics:
        google_analytics_id: "G-G57FLM9M46"
      home_page_in_toc: true
      repository_url: https://github.com/ProjectPythia/pythia-foundations # Online location of your book
      repository_branch: main # Which branch of the repository should be used when creating links (optional)
      use_issues_button: true
      use_repository_button: true
      use_edit_page_button: true
      use_fullscreen_button: true
      github_url: https://github.com/ProjectPythia
      twitter_url: https://twitter.com/project_pythia
      icon_links:
        - name: YouTube
          url: https://www.youtube.com/channel/UCoZPBqJal5uKpO8ZiwzavCw
          icon: fab fa-youtube-square
          type: fontawesome
      launch_buttons:
        binderhub_url: https://binder.projectpythia.org
        notebook_interface: jupyterlab
      extra_navbar: |
        We want your feedback! Fill out this <a href="https://docs.google.com/forms/d/e/1FAIpQLSeVa1TC9xM-dk7qIE2e8bsgSrIP82yYDNw3wew3J46eREJa4w/viewform?usp=sf_link">Google Form</a>
        or see our <a href="https://foundations.projectpythia.org/appendix/how-to-contribute.html">Contributor's Guide</a>.
      logo:
        link: https://projectpythia.org
      navbar_start:
        - navbar-logo
      navbar_links:
        - name: Home
          url: https://projectpythia.org
        - name: Foundations
          url: https://foundations.projectpythia.org
        - name: Cookbooks
          url: https://cookbooks.projectpythia.org
        - name: Resources
          url: https://projectpythia.org/resource-gallery.html
        - name: Community
          url: https://projectpythia.org/index.html#join-us
        - name: Blog
          url: https://projectpythia.org/blog.html
      navbar_end:
        - navbar-icon-links
      footer_logos:
        NCAR: images/logos/NSF-NCAR_Lockup-UCAR-Dark_102523.svg
        Unidata: images/logos/Unidata_logo_horizontal_1200x300.svg
        UAlbany: images/logos/UAlbany-A2-logo-purple-gold.svg
      footer_start:
        - footer-logos
        - footer-menu
        - footer-info
        - footer-extra