mkdocs.yml

site_name: BrickFlow
site_description: Brickflow is a tool for managing and deploying scalable workflows on Databricks.
site_url: https://brickflow.readthedocs.io/en/latest/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    # - announce.dismiss
    - content.code.annotate
    # - content.tabs.link
    - content.tooltips
    - content.code.copy
    # - header.autohide
    # - navigation.expand
    - navigation.indexes
    - navigation.instant
    # - navigation.prune
    # - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - navigation.expand
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  font:
    text: Roboto
    code: Roboto Mono
  logo: img/bf_logo.png
  favicon: img/bf_logo.png
  language: en

repo_name: nike/brickflow
repo_url: https://github.com/Nike-Inc/brickflow

plugins:
  - search:
      lang: en
  - mkdocstrings:
      handlers:
        python:
          paths: [ "brickflow" ]  # search packages in the src folder
          options:
            show_source: true
            show_root_heading: false
            heading_level: 1
            merge_init_into_class: true
            show_if_no_docstring: true
            show_root_full_path: true
            show_root_members_full_path: true
            show_root_toc_entry: false
            show_category_heading: true
            show_signature_annotations: true
            separate_signature: false

markdown_extensions:
  - abbr
  - admonition
  - mkdocs-click
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:materialx.emoji.to_svg
      emoji_index: !!python/name:materialx.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

watch:
  - brickflow
  - brickflow_plugins

extra_css:
  - css/custom.css

nav:
  - Home: index.md
  - Quickstart:
      - Brickflow Projects: bundles-quickstart.md
      - Upgrading Versions:
          - Upgrading to v0.10.x: upgrades/upgrade-pre-0-10-0-to-0-10-0.md
  - Concepts:
      - HighLevel: highlevel.md
      - Workflows: workflows.md
      - Tasks: tasks.md
      - Projects: projects.md
      - ENV Variables: environment-variables.md
      - Importing Modules: how-imports-work.md
  - FAQ: faq/faq.md
  - CLI:
      - Commands: cli/reference.md
  - Python API:
      - Engine:
          - Project: api/project.md
          - Workflow: api/workflow.md
          - Compute: api/compute.md
          - Task: api/task.md
      - Context: api/context.md
      - CLI: api/cli.md
      - Brickflow Plugins:
          - AirflowTaskDependencySensor: api/airflow_external_task_dependency.md
          - AirflowNativeOperators: api/airflow_native_operators.md
          - WorkflowDependencySensor: api/workflow_dependency_sensor.md
          - SnowflakeOperator: api/uc_to_snowflake_operator.md
          - UcToSnowflakeOperator: api/uc_to_snowflake_operator.md
          - Secrets: api/secrets.md
          - TableauRefreshDataSourceOperator: api/airflow_tableau_operators.md
          - TableauRefreshWorkbookOperator: api/airflow_tableau_operators.md
          - BoxToVolumeOperator: api/box_operator.md
          - VolumeToBoxOperator: api/box_operator.md
          - BoxOperator: api/box_operator.md


extra:
  generator: false
  version:
    provider: mike
    default: latest