mkdocs.yml

site_name: PgQueuer
site_description: "High-performance PostgreSQL job queue for Python"
site_url: https://janbjorge.github.io/pgqueuer/
repo_url: https://github.com/janbjorge/pgqueuer
repo_name: janbjorge/pgqueuer
edit_uri: edit/main/docs/
exclude_docs: |
  agent-guide.md
hooks:
  - tools/mkdocs_agent_guide.py
theme:
  name: material
  logo: favicon.svg
  favicon: favicon.svg
  palette:
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.indexes
    - navigation.top
    - navigation.expand
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - announce.dismiss
plugins:
  - search:
      lang: en

markdown_extensions:
  - toc:
      permalink: true
  - admonition
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
extra_css:
  - stylesheets/extra.css
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/janbjorge/pgqueuer
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pgqueuer/
nav:
  - Home: index.md
  - Getting Started:
      - Installation: getting-started/installation.md
      - Quick Start: getting-started/quickstart.md
      - Core Concepts: getting-started/core-concepts.md
      - When to Use PgQueuer: getting-started/when-to-use.md
      - Upgrading from 0.x: getting-started/upgrading.md
  - Guides:
      - Job Processing:
          - Concurrency Control: guides/concurrency-control.md
          - Custom Executors: guides/custom-executors.md
          - Job Cancellation: guides/job-cancellation.md
          - Completion Tracking: guides/completion-tracking.md
          - Deferred Execution: guides/deferred-execution.md
      - Scheduling: guides/scheduling.md
      - Reliability:
          - Reliability Model: guides/reliability.md
          - Database-Level Retry: guides/retry.md
          - Holding Failed Jobs: guides/hold-failed-jobs.md
          - Heartbeat Monitoring: guides/heartbeat.md
      - Shared Resources: guides/shared-resources.md
      - Performance & Deployment:
          - Performance Tuning: guides/performance-tuning.md
          - Deployment Patterns: guides/deployment.md
          - Docker Images: guides/docker-images.md
  - Reference:
      - CLI: reference/cli.md
      - System Design: design/README.md
      - Dequeue Composition: design/dequeue-composition.md
      - Schema Manifest: design/schema-manifest.md
      - Schema Upgrade: design/schema-upgrade.md
      - SQL Naming: design/sql-naming.md
      - Connection Failures: design/connection-failures.md
      - Architecture: reference/architecture.md
      - Row Locking & SKIP LOCKED: reference/skip-locked.md
      - Drivers: reference/drivers.md
      - Database Setup: reference/database-setup.md
      - Database Permissions: reference/database-permissions.md
      - In-Memory Adapter: reference/in-memory.md
  - Integrations:
      - Web Dashboard: integrations/web-dashboard.md
      - MCP Server: integrations/mcp-server.md
      - Prometheus Metrics: integrations/prometheus.md
      - Distributed Tracing: integrations/tracing.md
      - PostgREST: integrations/postgrest.md
  - Comparisons:
      - PgQueuer vs Celery: comparisons/celery-comparison.md
      - Benchmarks: comparisons/benchmarks.md
  - Development:
      - Contributing: development/development.md
      - Architecture Decision Records: adr/README.md
      - Ports & Adapters: reference/ports-and-adapters.md
      - Driver Troubleshooting: development/troubleshooting.md