_config.yml

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

title: DAMAST - documentation
author: "Jørgen S. Dokken and Thomas Roehr"

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


# 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/simula/damast  # Online location of your book
  path_to_book: "." # Optional path to your book, relative to the repository root
  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_repository_button: true

exclude_patterns: [".tox", ".pytest_cache", "src/damast/domains/maritime/README.md"]


sphinx:
  extra_extensions:
  - 'sphinx.ext.todo'
  - 'sphinx.ext.autodoc'
  - 'sphinx.ext.napoleon'
  - 'autoapi.extension'

  config:
    html_last_updated_fmt: "%b %d, %Y"
    todo_include_todos: True
    autoapi_dirs: ['src']
    # Ref: https://github.com/executablebooks/sphinx-external-toc/issues/36
    suppress_warnings: ["etoc.toctree"]