mkdocs.yml

site_name: RAMPART
site_description: A pytest-native safety testing framework for agentic AI applications
site_url: https://microsoft.github.io/RAMPART/
repo_url: https://github.com/microsoft/RAMPART
repo_name: microsoft/RAMPART
edit_uri_template: blob/main/docs/{path}

copyright: Copyright © 2026 Microsoft Corporation

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: info
  anchors: warn
  nav:
    not_found: warn
    omitted_files: warn
    absolute_links: warn

not_in_nav: |
  404.md

exclude_docs: |
  _includes/
  _overrides/

extra:
  generator: false
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/microsoft/RAMPART
      name: RAMPART on GitHub

theme:
  name: material
  custom_dir: docs/_overrides
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.progress
    - navigation.path
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
  icon:
    repo: fontawesome/brands/github
  logo: images/RAMPART.svg
  favicon: images/RAMPART.svg

extra_css:
  - stylesheets/custom.css

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - tables
  - 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
      auto_title: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.snippets:
      base_path: [!relative $config_dir]
      check_paths: true
      auto_append:
        - docs/_includes/abbreviations.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

plugins:
  - search
  - privacy
  - git-revision-date-localized:
      type: timeago
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_full_path: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false
            signature_crossrefs: true
            separate_signature: true
            heading_level: 2
            filters:
              - "!^_"

nav:
  - Home: index.md
  - Getting Started:
      - getting-started/index.md
      - Installation: getting-started/installation.md
      - Quickstart: getting-started/quickstart.md
  - Concepts:
      - concepts/index.md
      - Overview: concepts/overview.md
      - Attacks: concepts/attacks.md
      - Probes: concepts/probes.md
      - PyRIT Integration: concepts/pyrit.md
  - Attacks:
      - attacks/index.md
      - XPIA: attacks/xpia.md
  - Probes:
      - probes/index.md
      - Behavioral: probes/behavioral.md
  - Usage:
      - usage/index.md
      - Writing Tests: usage/authoring-tests.md
      - Configuration: usage/configuration.md
      - pytest Markers & Fixtures: usage/pytest-integration.md
      - Results & Reporting: usage/results-and-reporting.md
      - Parallel Execution: usage/xdist.md
      - CI Integration: usage/ci-integration.md
  - Contributing:
      - contributing/index.md
      - Development Setup: contributing/development-setup.md
      - Code Style & Linting: contributing/code-style.md
      - Testing Standards: contributing/testing.md
      - Architecture: contributing/architecture.md
      - Extending RAMPART: contributing/extending-rampart.md
      - Pull Request Process: contributing/pull-requests.md
      - Release Process: contributing/release-process.md
  - API Reference:
      - api/index.md
      - Core Types: api/core-types.md
      - Core Protocols: api/core-protocols.md
      - Attacks: api/attacks.md
      - Probes: api/probes.md
      - Evaluators: api/evaluators.md
      - Drivers: api/drivers.md
      - Payloads: api/payloads.md
      - Surfaces: api/surfaces.md
      - Converters: api/converters.md
      - Reporting: api/reporting.md
      - pytest Plugin: api/pytest-plugin.md
  - Glossary: glossary.md