mkdocs.yml

site_name: OrionBelt Semantic Layer
site_description: Compile and execute YAML semantic models as analytical SQL across multiple database dialects.
site_url: https://ralfbecher.github.io/orionbelt-semantic-layer/
repo_url: https://github.com/ralfbecher/orionbelt-semantic-layer
repo_name: orionbelt-semantic-layer
copyright: Copyright © 2025 RALFORION d.o.o. — BSL 1.1

dev_addr: 127.0.0.1:8080

extra:
  obml_version: "1.0"
  project_version: "2.1.3"
  analytics:
    provider: google
    property: G-X19K4GX3EX
    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 by
            <a href="https://github.com/ralfbecher/orionbelt-semantic-layer/issues/new?labels=docs&template=docs-feedback.md" target="_blank" rel="noopener">opening a docs issue</a>.
  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.
    actions:
      - accept
      - reject
      - manage

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo_w.png
  favicon: assets/favicon.png
  palette:
    - scheme: default
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.tabs.link
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            members_order: source
            docstring_style: google

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.snippets
  - tables
  - toc:
      permalink: true
  - attr_list
  - md_in_html
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Docker & Deployment: getting-started/docker.md
      - Development: getting-started/development.md
  - Guide:
      - OBML Model Format: guide/model-format.md
      - Query Language: guide/query-language.md
      - SQL Dialects: guide/dialects.md
      - Grain & Filter Context: guide/grain-filter-context.md
      - Period-over-Period Metrics: guide/period-over-period.md
      - Compilation Pipeline: guide/compilation.md
      - OBSL Graph & SPARQL: guide/obsl.md
      - Gradio UI: guide/ui.md
      - AI Integrations: guide/integrations.md
      - OSI Interoperability: guide/osi.md
  - API:
      - Overview: api/overview.md
      - Endpoints: api/endpoints.md
      - OpenAPI / Swagger: api/openapi.md
  - Examples:
      - Sales Model Walkthrough: examples/sales-model.md
      - Multi-Dialect Output: examples/multi-dialect.md
      - "Multi-Fact: Sales & Returns": examples/multi-fact.md
      - TPC-DS Benchmark: examples/tpcds.md
  - Comparison:
      - Overview: comparison/index.md
      - vs. dbt Semantic Layer: comparison/dbt.md
      - vs. Malloy: comparison/malloy.md
      - vs. LookML / Looker: comparison/lookml.md
      - vs. Cube: comparison/cube.md
      - vs. AtScale: comparison/atscale.md
  - Reference:
      - Python API: reference/python-api.md
      - Architecture: reference/architecture.md
      - Configuration: reference/configuration.md
  - Drivers & Flight SQL: drivers.md