mkdocs.yaml

# Local development:
#   uv pip install -e ".[plus]" --group docs
#   python -m mkdocs serve     # live-reload at http://127.0.0.1:8000
#   python -m mkdocs build     # static output → site/

site_name: RF-DETR
site_url: https://rfdetr.roboflow.com/
site_author: Roboflow
site_description: "Real-time transformer for object detection and instance segmentation. DINOv2 backbone, SOTA on COCO (60.1 AP50:95). Apache 2.0. Works with Python ≥3.10."
exclude_docs: |
  root-static/
repo_name: roboflow/rf-detr
repo_url: https://github.com/roboflow/rf-detr
edit_uri: https://github.com/roboflow/rf-detr/tree/main/docs
copyright: Roboflow 2025–2026. All rights reserved.

extra:
  og_image: https://storage.googleapis.com/com-roboflow-marketing/rf-detr/rf_detr_1-4_latency_accuracy_object_detection.png
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/roboflow
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/roboflow
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/roboflow-ai/mycompany/
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/roboflow
  version:
    provider: mike

nav:
  - Home: index.md
  - How to:
      - Getting Started:
          - Install: getting-started/install.md
          - Migration Guide: getting-started/migration.md
      - Run Model:
          - Detection: learn/run/detection.md
          - Segmentation: learn/run/segmentation.md
          - Keypoints: learn/run/keypoints.md
          - Pretrained Models: learn/pretrained.md
      - Train Model:
          - Overview: learn/train/index.md
          - Dataset Formats: learn/train/dataset-formats.md
          - Training Parameters: learn/train/training-parameters.md
          - Advanced Training: learn/train/advanced.md
          - Custom Training API: learn/train/customization.md
          - Augmentations: learn/train/augmentations.md
          - Training Loggers: learn/train/loggers.md
      - Export Model: learn/export.md
      - Deploy Model: learn/deploy.md
      - Benchmarks: learn/benchmarks.md
  - API Reference:
      - RF-DETR: reference/rfdetr.md
      - Detection Models:
          - RF-DETR Nano: reference/nano.md
          - RF-DETR Small: reference/small.md
          - RF-DETR Medium: reference/medium.md
          - RF-DETR Large: reference/large.md
          - RF-DETR XLarge: reference/xlarge.md
          - RF-DETR 2XLarge: reference/2xlarge.md
      - Segmentation Models:
          - RF-DETR Seg Nano: reference/seg_nano.md
          - RF-DETR Seg Small: reference/seg_small.md
          - RF-DETR Seg Medium: reference/seg_medium.md
          - RF-DETR Seg Large: reference/seg_large.md
          - RF-DETR Seg XLarge: reference/seg_xlarge.md
          - RF-DETR Seg 2XLarge: reference/seg_2xlarge.md
      - Keypoint Models:
          - RF-DETR Keypoint Preview: reference/kp_preview.md
      - Training Configs:
          - Train Config: reference/train_config.md
          - Segmentation Train Config: reference/segmentation_train_config.md
          - Keypoint Train Config: reference/keypoint_train_config.md
      - Lightning Training:
          - Training Primitives: reference/training.md
  - FAQ: faq.md
  - Cookbooks: cookbooks.md
  - Resources: resources/index.md
  - Changelog: changelog.md

theme:
  name: "material"
  icon:
    edit: material/pencil
  logo: assets/roboflow-logo.svg
  favicon: assets/roboflow-logo.svg
  custom_dir: docs/theme

  #  palette:
  #    # Palette for light mode
  #    - scheme: default
  #      primary: "custom"
  #      toggle:
  #        icon: material/brightness-7
  #        name: Switch to dark mode
  #
  #    # Palette toggle for dark mode
  #    - scheme: slate
  #      primary: "custom"
  #      toggle:
  #        icon: material/brightness-4
  #        name: Switch to light mode

  font:
    text: Inter
    code: IBM Plex Mono

  features:
    - content.tabs.link
    - content.code.copy
    - navigation.expand
    - navigation.tabs
    - content.code.annotate
    - navigation.tracking
    - content.tooltips
    - navigation.tabs.sticky

plugins:
  - search
  - mkdocs-jupyter:
      kernel_name: python3
      execute: false
      include_source: True
      include_requirejs: true
      ignore:
        - "hooks/*.py"
  - git-revision-date-localized:
      enable_creation_date: false
      type: iso_datetime
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [rf-detr]
          load_external_modules: true
          options:
            parameter_headings: true
            allow_inspection: true
            show_bases: true
            group_by_category: true
            docstring_style: google
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_category_heading: true

hooks:
  - docs/hooks/package_version.py
  - docs/hooks/cookbooks_cards.py

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

extra_css:
  - stylesheets/rf.css

extra_javascript: []