mkdocs.yml

site_name: PydanticAI
site_description: Agent Framework / shim to use Pydantic with LLMs
strict: true
site_url: https://ai.pydantic.dev

repo_name: pydantic/pydantic-ai
repo_url: https://github.com/pydantic/pydantic-ai
edit_uri: edit/main/docs/

copyright: © Pydantic Services Inc. 2024 to present

nav:
  - Introduction: index.md
  - install.md
  - help.md
  - contributing.md
  - troubleshooting.md
  - Documentation:
    - agents.md
    - models.md
    - dependencies.md
    - tools.md
    - results.md
    - message-history.md
    - testing-evals.md
    - logfire.md
    - multi-agent-applications.md
  - Examples:
    - examples/index.md
    - examples/pydantic-model.md
    - examples/weather-agent.md
    - examples/bank-support.md
    - examples/sql-gen.md
    - examples/flight-booking.md
    - examples/rag.md
    - examples/stream-markdown.md
    - examples/stream-whales.md
    - examples/chat-app.md
  - API Reference:
    - api/agent.md
    - api/tools.md
    - api/result.md
    - api/messages.md
    - api/exceptions.md
    - api/settings.md
    - api/usage.md
    - api/format_as_xml.md
    - api/models/base.md
    - api/models/openai.md
    - api/models/anthropic.md
    - api/models/gemini.md
    - api/models/vertexai.md
    - api/models/groq.md
    - api/models/mistral.md
    - api/models/ollama.md
    - api/models/test.md
    - api/models/function.md

extra:
  # hide the "Made with Material for MkDocs" message
  generator: false

theme:
  name: "material"
  custom_dir: docs/.overrides
  palette:
    - media: "(prefers-color-scheme)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb
        name: "Switch to light mode"
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb-outline
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: pink
      accent: pink
      toggle:
        icon: material/lightbulb-auto-outline
        name: "Switch to system preference"
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.path
#    - navigation.expand
    - navigation.indexes
    - navigation.sections
    - navigation.tracking
    - toc.follow
#    - navigation.tabs  # don't use navbar tabs
  logo: "img/logo-white.svg"
  favicon: "favicon.ico"

# https://www.mkdocs.org/user-guide/configuration/#validation
validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn
  anchors: warn

extra_css:
  - "extra/tweaks.css"
# used for analytics
extra_javascript:
  - "/flarelytics/client.js"

markdown_extensions:
  - tables
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.tilde
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra:
      pymdownx.superfences:
        custom_fences:
          - name: mermaid
            class: mermaid
            format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      options:
        custom_icons:
            - docs/.overrides/.icons
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - sane_lists # this means you can start a list from any number

watch:
  - pydantic_ai_slim
  - examples

plugins:
  - search
  - social
  - glightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [src/packages/pydantic_ai_slim/pydantic_ai]
          options:
            relative_crossrefs: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            group_by_category: false
            # 3 because docs are in pages with an H2 just above them
            heading_level: 3
          import:
            - url: https://docs.python.org/3/objects.inv
            - url: https://docs.pydantic.dev/latest/objects.inv
            - url: https://dirty-equals.helpmanual.io/latest/objects.inv
            - url: https://fastapi.tiangolo.com/objects.inv
            - url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
            - url: https://rich.readthedocs.io/en/stable/objects.inv
            # waiting for https://github.com/encode/httpx/discussions/3091#discussioncomment-11205594

hooks:
- 'docs/.hooks/main.py'