mkdocs.yml

site_name: Marvin
site_description: "The AI Engineering Toolkit"
site_url: https://askmarvin.ai
docs_dir: docs
repo_url: https://github.com/prefecthq/marvin

nav:
  - Docs:
      - welcome/what_is_marvin.md

      - Getting started:
          - Installation: welcome/installation.md
          - Tutorial: welcome/tutorial.md
        # - help/legacy_docs.md

      # - Overview: welcome/overview.md

      - Text:
          - Transforming to data: docs/text/transformation.md
          - Extracting entities: docs/text/extraction.md
          - Classification: docs/text/classification.md
          - Generating synthetic data: docs/text/generation.md
          - AI functions: docs/text/functions.md

      - Images:
          - Creating images: docs/images/generation.md
          - Generating captions: docs/vision/captioning.md
          - Transforming to data: docs/vision/transformation.md
          - Extracting entities: docs/vision/extraction.md
          - Classification: docs/vision/classification.md

      - Audio:
          - Generating speech: docs/audio/speech.md
          - Transcribing speech: docs/audio/transcription.md
          - Recording audio: docs/audio/recording.md

      - Video:
          - Recording video: docs/video/recording.md

      - Interactive Tools:
          - Assistants: docs/interactive/assistants.md
          - CLI: docs/interactive/cli.md
          - Applications: docs/interactive/applications.md

      - Configuration:
          - Settings: docs/configuration/settings.md

  - API reference:
      - marvin: api_reference/marvin.md
      - AI modules:
          - marvin.ai.text: api_reference/ai/text.md
          - marvin.ai.images: api_reference/ai/images.md
          - marvin.ai.audio: api_reference/ai/audio.md
      - Beta AI modules:
          - marvin.beta.assistants:
              - marvin.beta.assistants: api_reference/beta/assistants/index.md
              - marvin.beta.assistants.assistants: api_reference/beta/assistants/assistants.md
              - marvin.beta.assistants.threads: api_reference/beta/assistants/threads.md
              - marvin.beta.assistants.runs: api_reference/beta/assistants/runs.md
              - marvin.beta.assistants.formatting: api_reference/beta/assistants/formatting.md
          - marvin.beta.applications: api_reference/beta/applications.md
      - Object schemas:
          - marvin.types: api_reference/types.md
      - Settings:
          - marvin.settings: api_reference/settings.md
      - Utilities:
          - marvin.utilities.asyncio: api_reference/utilities/asyncio.md
          - marvin.utilities.context: api_reference/utilities/context.md
          - marvin.utilities.images: api_reference/utilities/images.md
          - marvin.utilities.jinja: api_reference/utilities/jinja.md
          - marvin.utilities.logging: api_reference/utilities/logging.md
          - marvin.utilities.openai: api_reference/utilities/openai.md
          - marvin.utilities.pydantic: api_reference/utilities/pydantic.md
          - marvin.utilities.python: api_reference/utilities/python.md
          - marvin.utilities.strings: api_reference/utilities/strings.md
          - marvin.utilities.testing: api_reference/utilities/testing.md
          - marvin.utilities.tools: api_reference/utilities/tools.md

  - Cookbook:
      - Entity deduplication: examples/deduplication.md
      # - GitHub Activity Digest: examples/github_digest.md
      - Slackbot: examples/slackbot.md
      - Python augmented prompts: examples/python_augmented_prompts.md
      - Being specific about types: examples/being_specific_about_types.md
      - Examples:
          - examples/audio_modification.md
          - examples/xkcd_bird.md
          - examples/michael_scott_business/michael_scott_business.md
          - examples/hogwarts_sorting_hat/hogwarts_sorting_hat.md
          - examples/call_routing.md

  - Community:
      - community/index.md
      - Feedback 💙: community/feedback.md
      - Contributing: community/development_guide.md

theme:
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.indexes
    - toc.follow
    - content.code.copy
    - content.code.select
    - content.code.annotate
  palette:
    primary: blue
    accent: teal
  name: material
  custom_dir: docs/overrides
  logo: assets/images/logos/askmarvin_mascot.jpeg
  favicon: assets/images/logos/askmarvin_mascot.jpeg

plugins:
  - search
  - markdownextradata
  - social:
      cards: !ENV [MKDOCS_SOCIAL_CARDS, false]
      cards_layout_options:
        font_family: Inter
        # background_color: "#2d6df6"
        background_color: "#181544" # marvin blue
  - awesome-pages
  - autolinks
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: false
            show_root_heading: false
            show_root_toc_entry: false
            show_object_full_path: false
            show_category_heading: false
            show_bases: false
            show_submodules: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_if_no_docstring: false
            show_signature: false
            heading_level: 2
            filters: ["!^_"]
          import:
            - https://docs.python-requests.org/en/master/objects.inv
watch:
  - src
  - docs
  - mkdocs.yml

hooks:
  - docs/hooks.py

markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
      title: On this page

extra:
  get_started: welcome/what_is_marvin
  hero:
    title: "The AI Engineering Toolkit"
    description: "Marvin is a lightweight toolkit for building natural language interfaces that are reliable, scalable, and easy to trust."
  announcement:
    title: "Marvin 2.0 is here!"
    url: https://github.com/PrefectHQ/marvin/releases/tag/v2.0.0
  analytics:
    provider: google
    property: G-2MWKMDJ9CM
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/prefecthq/marvin
    - icon: fontawesome/brands/discord
      link: https://discord.gg/Kgw4HpcuYG
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/askmarvinai

extra_css:
  - /static/css/global.css
  - /static/css/badges.css
  - /static/css/custom.css
  - /static/css/mkdocstrings.css