mkdocs.yml

site_name: Docling Graph Documentation
site_description: Convert documents into knowledge graphs using Docling
site_author: IBM Research
site_url: https://ibm.github.io/docling-graph

repo_name: docling-project/docling-graph
repo_url: https://github.com/docling-project/docling-graph
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  logo: assets/logo.png
  favicon: assets/logo.png
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true

markdown_extensions:
  - pymdownx.tasklist:
      clickable_checkbox: true
  - pymdownx.highlight:
      anchor_linenums: 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
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - toc:
      toc_depth: 2-3
      permalink: true

nav:
  - Home: index.md
  
  - Introduction:
    - Overview: introduction/index.md
    - Architecture: introduction/architecture.md
    - Key Concepts: introduction/key-concepts.md
    - Use Cases: introduction/use-cases.md
    - Quick Start: introduction/quickstart.md
  
  - Fundamentals:
    - Overview: fundamentals/index.md
    - Installation:
      - Overview: fundamentals/installation/index.md
      - Requirements: fundamentals/installation/requirements.md
      - Basic Setup: fundamentals/installation/basic-setup.md
      - GPU Setup: fundamentals/installation/gpu-setup.md
      - API Keys: fundamentals/installation/api-keys.md
    - Schema Definition:
      - Overview: fundamentals/schema-definition/index.md
      - Template Basics: fundamentals/schema-definition/template-basics.md
      - Entities vs Components: fundamentals/schema-definition/entities-vs-components.md
      - Field Definitions: fundamentals/schema-definition/field-definitions.md
      - Relationships: fundamentals/schema-definition/relationships.md
      - Validation: fundamentals/schema-definition/validation.md
      - Advanced Patterns: fundamentals/schema-definition/advanced-patterns.md
      - Staged Extraction Schema: fundamentals/schema-definition/staged-extraction-schema.md
      - Best Practices: fundamentals/schema-definition/best-practices.md
    - Pipeline Configuration:
      - Overview: fundamentals/pipeline-configuration/index.md
      - Configuration Basics: fundamentals/pipeline-configuration/configuration-basics.md
      - Input Formats: fundamentals/pipeline-configuration/input-formats.md
      - Backend Selection: fundamentals/pipeline-configuration/backend-selection.md
      - Model Configuration: fundamentals/pipeline-configuration/model-configuration.md
      - Processing Modes: fundamentals/pipeline-configuration/processing-modes.md
      - Docling Settings: fundamentals/pipeline-configuration/docling-settings.md
      - Export Configuration: fundamentals/pipeline-configuration/export-configuration.md
      - Configuration Examples: fundamentals/pipeline-configuration/configuration-examples.md
    - Extraction Process:
      - Overview: fundamentals/extraction-process/index.md
      - Document Conversion: fundamentals/extraction-process/document-conversion.md
      - Chunking Strategies: fundamentals/extraction-process/chunking-strategies.md
      - Extraction Backends: fundamentals/extraction-process/extraction-backends.md
      - Delta Extraction: fundamentals/extraction-process/delta-extraction.md
      - Staged Extraction: fundamentals/extraction-process/staged-extraction.md
      - Model Merging: fundamentals/extraction-process/model-merging.md
      - Batch Processing: fundamentals/extraction-process/batch-processing.md
    - Graph Management:
      - Overview: fundamentals/graph-management/index.md
      - Graph Conversion: fundamentals/graph-management/graph-conversion.md
      - Graph Analysis: fundamentals/graph-management/graph-analysis.md
      - Export Formats: fundamentals/graph-management/export-formats.md
      - Visualization: fundamentals/graph-management/visualization.md
      - Neo4j Integration: fundamentals/graph-management/neo4j-integration.md
  
  - Usage:
    - Overview: usage/index.md
    - CLI Reference:
      - Overview: usage/cli/index.md
      - init Command: usage/cli/init-command.md
      - convert Command: usage/cli/convert-command.md
      - inspect Command: usage/cli/inspect-command.md
      - CLI Recipes: usage/cli/cli-recipes.md
    - Python API:
      - Overview: usage/api/index.md
      - PipelineConfig: usage/api/pipeline-config.md
      - LLM Model Config: usage/api/llm-model-config.md
      - run_pipeline: usage/api/run-pipeline.md
      - Batch Processing: usage/api/batch-processing.md
      - Programmatic Examples: usage/api/programmatic-examples.md
    - Examples:
      - Overview: usage/examples/index.md
      - By Input Format:
        - URL Input: usage/examples/url-input.md
        - Markdown Input: usage/examples/markdown-input.md
        - DoclingDocument Input: usage/examples/docling-document-input.md
      - By Domain:
        - Billing Document: usage/examples/billing-document.md
        - ID Card: usage/examples/id-card.md
        - Insurance Policy: usage/examples/insurance-policy.md
        - Rheology Research: usage/examples/rheology_research.md
    - Advanced Topics:
      - Overview: usage/advanced/index.md
      - Performance Tuning: usage/advanced/performance-tuning.md
      - Error Handling: usage/advanced/error-handling.md
      - Trace Data Debugging: usage/advanced/trace-data-debugging.md
      - Custom Backends: usage/advanced/custom-backends.md
      - Custom Stages: usage/advanced/custom-stages.md
      - Custom Exporters: usage/advanced/custom-exporters.md
      - Testing: usage/advanced/testing.md
  
  - Reference:
    - Overview: reference/index.md
    - Pipeline: reference/pipeline.md
    - Config: reference/config.md
    - Protocols: reference/protocols.md
    - Exceptions: reference/exceptions.md
    - Converters: reference/converters.md
    - Extractors: reference/extractors.md
    - Exporters: reference/exporters.md
    - LLM Clients: reference/llm-clients.md
  
  - Community:
    - Overview: community/index.md
    - GitHub Workflow: community/github-workflow.md
    - Release Process: community/release-process.md

extra_css:
  - stylesheets/extra.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/docling-project/docling-graph
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/docling-graph/
  version:
    provider: mike