_config.yml

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

title: Microscopy for Beginners reference guide
author: ""
copyright                   : "2024"  # Copyright year to be placed in the footer
logo                        : "logo.png"  # A path to the book logo
# Patterns to skip when building the book. Can be glob-style (e.g. "*skip.ipynb")
exclude_patterns            : [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints"]
# Auto-exclude files not in the toc
only_build_toc_files        : false


# Force re-execution of notebooks on each build.
# See https://jupyterbook.org/content/execute.html
execute:
  execute_notebooks: force

# 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

# Information about where the book exists on the web
repository:
  url: https://github.com/broadinstitute/MicroscopyForBeginnersReferenceGuide  # Online location of your book
  branch: main  # Which branch of the repository should be used when creating links (optional)

# Add GitHub buttons to your book
# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
html:
  use_issues_button: true
  use_repository_button: true
  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
  favicon                   : "favicon.png"  # A path to a favicon image
  google_analytics_id: G-LDZ3MLCB50
  comments:
    hypothesis: true
  extra_footer: |
    <p>
    <a href="https://www.bioimagingguide.org">English</a> <a href="https://cs.bioimagingguide.org">česky</a> <a href="https://pt.bioimagingguide.org">português</a> <a href="https://es.bioimagingguide.org">español</a>
    </p>

sphinx:
  extra_extensions:
    - sphinxcontrib.mermaid
  config:
    bibtex_reference_style: super
    locale_dirs: ["locale/"]
    gettext_compact: true