mkdocs.yml

site_name: Pydantic Deep Agents
site_description: Build Claude Code-Style AI Agents in Python
site_url: https://vstorm-co.github.io/pydantic-deepagents/
repo_url: https://github.com/vstorm-co/pydantic-deepagents
repo_name: vstorm-co/pydantic-deepagents

theme:
  name: material
  custom_dir: docs/overrides
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  font:
    text: Inter
    code: JetBrains Mono
  logo: assets/logo.svg
  favicon: assets/favicon.png
  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16
  features:
    # Navigation
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.tracking
    - navigation.path
    - navigation.top
    - navigation.footer
    - navigation.indexes
    # Search
    - search.suggest
    - search.highlight
    - search.share
    # Content
    - content.tabs.link
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.tooltips
    # Table of contents
    - toc.follow
    # Header
    - announce.dismiss

plugins:
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - social:
      enabled: !ENV [CI, false]
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            signature_crossrefs: true
  - llmstxt:
      full_output: llms-full.txt
      sections:
        Getting Started:
          - index.md: Project overview and quick start
          - installation.md: Installation instructions
          - getting-help.md: How to get help
        Core Concepts:
          - concepts/index.md: Core concepts overview
          - concepts/agents.md: Agent creation and configuration
          - concepts/backends.md: Backend abstraction for file operations
          - concepts/toolsets.md: Available toolsets and custom tools
          - concepts/skills.md: Skills system
        Advanced Features:
          - advanced/human-in-the-loop.md: Human-in-the-loop patterns
          - advanced/subagents.md: Subagent delegation
          - advanced/streaming.md: Streaming responses
          - advanced/structured-output.md: Structured output
          - advanced/processors.md: History processors and summarization
          - advanced/checkpointing.md: Conversation checkpointing and rewind
          - advanced/teams.md: Agent teams with shared todos
          - advanced/output-styles.md: Output style customization
          - advanced/hooks.md: Claude Code-style lifecycle hooks
          - advanced/memory.md: Persistent agent memory
          - advanced/context-files.md: Project context file injection
          - advanced/eviction.md: Large output eviction
          - advanced/cost-tracking.md: Token and cost tracking
          - advanced/middleware.md: Middleware system
          - advanced/plan-mode.md: Plan mode subagent
          - advanced/web-tools.md: Web search, fetch, and HTTP tools
          - advanced/multi-user.md: Multi-user isolation patterns
        CLI:
          - cli/index.md: CLI installation, commands, and features
        Examples:
          - examples/*.md
        API Reference:
          - api/agent.md: Agent factory API
          - api/backends.md: Backend API
          - api/toolsets.md: Toolset API
          - api/processors.md: Processor API
          - api/types.md: Type definitions

markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - toc:
      permalink: true
      toc_depth: 3
  # PyMdownx
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

extra:
  status:
    new: Recently added
    deprecated: Deprecated
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/vstorm-co/pydantic-deepagents
      name: GitHub
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/pydantic-deep/
      name: PyPI
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
  generator: false
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/extra.js

nav:
  - Pydantic Deep Agents: index.md
  - Installation: installation.md
  - Getting Help: getting-help.md
  - Core Concepts:
    - concepts/index.md
    - Agents: concepts/agents.md
    - Backends: concepts/backends.md
    - Toolsets: concepts/toolsets.md
    - Skills: concepts/skills.md
  - Advanced Features:
    - advanced/human-in-the-loop.md
    - advanced/subagents.md
    - advanced/streaming.md
    - advanced/structured-output.md
    - advanced/processors.md
    - advanced/checkpointing.md
    - advanced/teams.md
    - advanced/output-styles.md
    - advanced/hooks.md
    - advanced/memory.md
    - advanced/context-files.md
    - advanced/eviction.md
    - advanced/cost-tracking.md
    - advanced/middleware.md
    - advanced/plan-mode.md
    - advanced/web-tools.md
    - advanced/multi-user.md
  - CLI: cli/index.md
  - Examples:
    - examples/index.md
    - Getting Started:
      - examples/basic-usage.md
      - examples/filesystem.md
      - examples/composite-backend.md
    - Agent Features:
      - examples/subagents.md
      - examples/custom-tools.md
      - examples/skills.md
      - examples/file-uploads.md
    - Execution:
      - examples/docker-sandbox.md
      - examples/docker-runtimes.md
      - examples/streaming.md
      - examples/human-in-the-loop.md
    - Applications:
      - examples/interactive-chat.md
      - examples/full-app.md
  - API Reference:
    - api/index.md
    - Agent: api/agent.md
    - Backends: api/backends.md
    - Toolsets: api/toolsets.md
    - Processors: api/processors.md
    - Types: api/types.md

validation:
  nav:
    omitted_files: info