# Format documented here
# http://www.mkdocs.org/user-guide/configuration/
# https://squidfunk.github.io/mkdocs-material/getting-started/
# See this document for list of plugins to disable for offline (local) documentation
# https://squidfunk.github.io/mkdocs-material/setup/building-for-offline-usage/

edit_uri: ""
site_url: https://www.utplsql.org/
site_name: utPLSQL
site_description: utPLSQL Ultimate Testing Framework for Oracle PL/SQL
copyright: > 
  Copyright © 2016 - 2026 utPLSQL Team
  Change cookie settings
repo_url: https://github.com/utPLSQL/utPLSQL
extra_css:
  - stylesheets/extra.css
theme:
  name: material
  custom_dir: docs/overrides
  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/lightbulb-outline
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/lightbulb
        name: Switch to light mode
  logo: assets/icon-transparent.png
  favicon: assets/favicon.png
  features:
    - navigation.instant  # disable for offline docs
#    - navigation.indexes
    - navigation.tabs
    - navigation.tracking
    - navigation.top
    - toc.follow
    - toc.integrate
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.code.select

extra:
#  homepage: https://www.utPLSQL.org/
  # sets scope of cookies to use a common path (root)
  scope: "/"
  analytics:
    provider: google
    property: G-WMFVR98J0Q
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! Help us improve this page by
            using our GitHub Discussions.
  consent:
    title: Cookie consent
    description: >- 
      We use cookies to recognize your repeated visits and preferences, as well
      as to measure the effectiveness of our documentation and whether users
      find what they're searching for. With your consent, you're helping us to
      make our documentation better.
    # the cookie: utplsql-consent allows for shred cookie across all documentation versions and the global site
    cookie: utplsql-consent
  social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/utPLSQL
    - icon: fontawesome/regular/comment
      link: https://github.com/utPLSQL/utPLSQL/discussions
    - icon: fontawesome/brands/github
      link: https://github.com/utPLSQL
    - icon: fontawesome/solid/envelope
      link: mailto:utPLSQL@utPLSQL.org
  version:            # disable for offline docs
    provider: mike    # disable for offline docs
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde
  - toc:
      permalink: true
use_directory_urls: false
strict: true

plugins:
  - search
  - git-committers:
      repository: utPLSQL/utPLSQL
      branch: develop
      token: !ENV ["API_TOKEN_GITHUB"]
      exclude_committers:
        - github-actions[bot]
        - web-flow
  - mike
  - git-revision-date-localized: # disable for offline docs
      enable_creation_date: true # disable for offline docs
      type: datetime             # disable for offline docs

nav:
  - User Guide:
       - index.md
       - Installation: userguide/install.md
       - Getting Started: userguide/getting-started.md
       - Annotations: userguide/annotations.md
       - Expectations: userguide/expectations.md
       - Advanced data comparison: userguide/advanced_data_comparison.md
       - Running unit tests: userguide/running-unit-tests.md
       - Querying for test suites: userguide/querying_suites.md
       - Testing best practices: userguide/best-practices.md
       - Upgrade utPLSQL: userguide/upgrade.md
  - Reporting:
       - Using reporters: userguide/reporters.md
       - Code coverage: userguide/coverage.md
       - Error handling and reporting: userguide/exception-reporting.md