mkdocs.yml

site_name: docetl docs
# use_directory_urls: false
# strict: true
# docs_dir: docs
# site_dir: public/docs

# extra:
#   docs_url: /docs

repo_url: https://github.com/ucbepic/docetl
repo_name: ucbepic/docetl
remote_branch: gh-pages
nav:
  - Getting Started:
      - Overview: index.md
      - Installation: installation.md
      - Quick Start Tutorial: tutorial.md
      - Best Practices: best-practices.md
  
  - User Guide:
      - Core Concepts:
          - Operators & Validation: concepts/operators.md
          - Output Schemas: concepts/schemas.md
          - Pipelines: concepts/pipelines.md
          - Optimization: concepts/optimization.md
      - LLM-Powered Operators:
          - Map: operators/map.md
          - Resolve: operators/resolve.md
          - Reduce: operators/reduce.md
          - Parallel Map: operators/parallel-map.md
          - Filter: operators/filter.md
          - Equijoin: operators/equijoin.md
          - Cluster: operators/cluster.md
      - Auxiliary Operators:
          - Split: operators/split.md
          - Gather: operators/gather.md
          - Unnest: operators/unnest.md
          - Sample: operators/sample.md
          - Code: operators/code.md
      - APIs:
          - Python API Guide: python-api.md
          - Pandas Integration:
              - Overview: pandas/index.md
              - Operations: pandas/operations.md
              - Examples: pandas/examples.md
      - Performance:
          - Optimization Overview: optimization/overview.md
          - Configuration: optimization/configuration.md
          - Examples:
              - Basic Example: optimization/example.md
              - Python API Example: optimization/python-api.md
  
  - Tutorials & Examples:
    - Presidential Debate Analysis: examples/presidential-debate-themes.md
    - Product Review Mining: examples/mining-product-reviews.md
    - Medical Document Classification: examples/ollama.md
    - Legal Document Analysis: examples/split-gather.md
  
  - Developer Reference:
      - Technical Guides:
          - Custom Data Parsing: examples/custom-parsing.md
          - Rate Limiting Implementation: examples/rate-limiting.md
      - API Reference:
          - docetl Core: api-reference/docetl.md
          - CLI Interface: api-reference/cli.md
          - Operations: api-reference/operations.md
          - Optimizers: api-reference/optimizers.md
          - Python API: api-reference/python.md
  
  - Tools & Resources:
      - UI Playground:
          - Setup: playground/index.md
          - Tutorial: playground/tutorial.md
      - Community:
          - Getting Involved: community/index.md
          - Project Roadmap: community/roadmap.md

extra_css:
  - stylesheets/extra.css

theme:
  name: material
  icon:
    logo: fontawesome/solid/scroll
    repo: fontawesome/brands/git-alt
  favicon: assets/docetl-favicon-color.png
  extra_files:
    - assets/
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: custom
      accent: "#FDB515" # California Gold
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: custom
      accent: "#FDB515" # California Gold
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: custom
      accent: "#FDB515" # California Gold
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  font:
    text: Inter
    code: Source Code Pro

  features:
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.tracking
    - navigation.expand
    - navigation.path
    - navigation.prune
    - navigation.indexes
    - navigation.top
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - toc.follow
    - navigation.footer
    # - toc.integrate
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings
  - autorefs
  - glightbox

markdown_extensions:
  - abbr
  - admonition
  - def_list
  - footnotes
  - md_in_html
  - tables
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.details
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg