httphound/mkdocs.yml

site_name: HttpHound Documentation
site_description: HTTP reverse proxy testing framework
site_author: Fabrizio Furnari
site_url: https://gitlab.wikimedia.org/repos/sre/httphound/

# Repository
repo_name: sre/httphound
repo_url: https://gitlab.wikimedia.org/repos/sre/httphound/
edit_uri: edit/main/docs/

# Theme configuration
theme:
  name: material
  palette:
    # Light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - content.code.copy
    - content.code.annotate
  
  icon:
    repo: fontawesome/brands/git-alt

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - tables
  - footnotes
  - attr_list
  - md_in_html
  - toc:
      permalink: true

# Plugins
plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true

# Navigation structure
nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - CLI Reference: cli.md

  - API Reference:
    - BaseProxyTest: api/base-proxy-test.md
    - Configuration: api/configuration.md
    - Test Runner: api/test-runner.md
    - Validation: api/validation.md
   
  - Troubleshooting: troubleshooting.md
  - Contributing: contributing.md

# Extra
extra:
  version:
    provider: mike  # For versioned docs (optional)

watch:
  - docs