mkdocs.yml

site_name: Pydantic Logfire Documentation
site_description: Pydantic Logfire Documentation
strict: true
site_url: https://docs.pydantic.dev/logfire

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

copyright: © Pydantic Services Inc. 2024
extra:
  # hide the "Made with Material for MkDocs" message
  generator: false

theme:
  name: "material"
  custom_dir: "docs/overrides"
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb-outline
        name: "Switch to dark mode"
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/lightbulb
        name: "Switch to light mode"
  features:
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - navigation.indexes
    - navigation.path
    - navigation.tabs
    - navigation.instant
    - navigation.instant.preview
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.sections
    - navigation.tracking
    - navigation.top # alternatively, we could do navigation.tabs.sticky
    - toc.follow
  logo: "logo-white.svg"
  favicon: "favicon.png"

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

extra_css:
  - "extra/tweaks.css"

# used for analytics
extra_javascript:
  - "/flarelytics/client.js"

nav:
  - Intro:
      - index.md
  - Guides:
      - Guides: guides/index.md
      - First Steps:
          - First Steps: guides/first_steps/index.md
      - Onboarding Checklist:
          - Onboarding Checklist: guides/onboarding_checklist/index.md
          - Integrate Logfire: guides/onboarding_checklist/integrate.md
          - Add Logfire Manual Tracing: guides/onboarding_checklist/add_manual_tracing.md
          - Add Logfire Auto-Tracing: guides/onboarding_checklist/add_auto_tracing.md
          - Add Logfire Metrics: guides/onboarding_checklist/add_metrics.md
      - Web UI:
          - Intro to the Web UI: guides/web_ui/index.md
          - Live View: guides/web_ui/live.md
          - Dashboards: guides/web_ui/dashboards.md
          - Alerts: guides/web_ui/alerts.md
          - SQL Explorer: guides/web_ui/explore.md
      - Advanced User Guide:
          - Advanced User Guide: guides/advanced/index.md
          - Alternative Backends: guides/advanced/alternative_backends.md
          - Sampling: guides/advanced/sampling.md
          - Scrubbing: guides/advanced/scrubbing.md
          - Generators: guides/advanced/generators.md
          - Testing: guides/advanced/testing.md
          - Backfill: guides/advanced/backfill.md
          - Creating Write Tokens: guides/advanced/creating_write_tokens.md
  - Integrations:
      - Integrations: integrations/index.md
      - OpenTelemetry:
          - FastAPI: integrations/fastapi.md
          - Django: integrations/django.md
          - Flask: integrations/flask.md
          - Starlette: integrations/starlette.md
          - ASGI: integrations/asgi.md
          - WSGI: integrations/wsgi.md
          - HTTPX: integrations/httpx.md
          - Requests: integrations/requests.md
          - AIOHTTP: integrations/aiohttp.md
          - SQLAlchemy: integrations/sqlalchemy.md
          - Asyncpg: integrations/asyncpg.md
          - Psycopg: integrations/psycopg.md
          - PyMongo: integrations/pymongo.md
          - MySQL: integrations/mysql.md
          - Redis: integrations/redis.md
          - Celery: integrations/celery.md
          - System Metrics: integrations/system_metrics.md
      - Custom:
          - Pydantic: integrations/pydantic.md
          - OpenAI: integrations/openai.md
          - Anthropic: integrations/anthropic.md
      - Logging:
          - Logging: integrations/logging.md
          - Structlog: integrations/structlog.md
          - Loguru: integrations/loguru.md
      - Third Party:
          - Third Party: integrations/third_party/index.md
          - Mirascope: integrations/third_party/mirascope.md
          - LiteLLM: integrations/third_party/litellm.md
      - Use Cases:
          - Web Frameworks: integrations/use_cases/web_frameworks.md
  - Reference:
      - Reference: reference/index.md
      - Configuration: reference/configuration.md
      - Organization Structure: reference/organization_structure.md
      - SDK CLI: reference/cli.md
  - SDK API:
      - Logfire: api/logfire.md
      - Testing: api/testing.md
      - Propagate: api/propagate.md
      - Exceptions: api/exceptions.md
      - Integrations:
          - api/integrations/pydantic.md
          - api/integrations/logging.md
          - api/integrations/structlog.md
  - Help: help.md
  - Roadmap: roadmap.md
  - Legal:
      - Terms of Service: legal/terms_of_service.md
      - Privacy Policy: legal/privacy.md
      - Service Level Agreement: legal/service_level_agreement.md
      - Data Processing Addendum: legal/data_processing_addendum.md
      - Cloud Subprocessors: legal/cloud_subprocessors.md
  - Release Notes: release-notes.md

markdown_extensions:
  - tables
  - toc:
      permalink: true
      title: Page contents
      # this only affects `/legal/` since (at time of change) there are no `h5` in the rest of the docs
      toc_depth: 4
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.snippets
  - 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
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - sane_lists # this means you can start a list from any number

watch:
  - logfire

plugins:
  - search
  - glightbox
  - mkdocstrings:
      handlers:
        python:
          paths: [src/packages/logfire/logfire]
          options:
            members_order: source
            separate_signature: true
            filters: ["!^_"]
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            parameter_headings: true
            show_signature_annotations: true
            signature_crossrefs: true
          import:
            - url: https://docs.python.org/3/objects.inv
            - url: https://docs.pydantic.dev/latest/objects.inv
            - url: https://fastapi.tiangolo.com/objects.inv
            - url: https://opentelemetry-python-contrib.readthedocs.io/en/latest/objects.inv
            - url: https://opentelemetry-python.readthedocs.io/en/latest/objects.inv
            - url: https://requests.readthedocs.io/en/latest/objects.inv
            - url: https://typing-extensions.readthedocs.io/en/latest/objects.inv
            - url: https://rich.readthedocs.io/en/stable/objects.inv
hooks:
  - docs/plugins/main.py