mkdocs.yml

site_name: Katana OpenAPI Client
site_description: Production-ready Python client for Katana Manufacturing ERP API
site_author: Doug Borg
site_url: https://dougborg.github.io/katana-openapi-client/
# Note: Custom domain (katana-openapi-client.dougborg.org) available once DNS is configured

repo_name: dougborg/katana-openapi-client
repo_url: https://github.com/dougborg/katana-openapi-client
edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.suggest
    - content.tabs.link
    - content.code.copy
    - content.action.edit
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: SUMMARY.md
  - swagger-ui-tag
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_inheritance_diagram: false
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            show_object_full_path: false
            show_category_heading: true
            group_by_category: true
            heading_level: 2
            members_order: alphabetical
            docstring_section_style: list
          inventories:
            - https://docs.python.org/3/objects.inv

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: dougborg
      repo: katana-openapi-client
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

nav:
  - Home: index.md
  - Client:
      - User Guide: client/guide.md
      - Cookbook: client/cookbook.md
      - Testing: client/testing.md
      - Changelog: client/CHANGELOG.md
      - ADRs:
          - Overview: client/adr/README.md
          - ADR-001 Transport-Layer Resilience: client/adr/0001-transport-layer-resilience.md
          - ADR-002 OpenAPI Code Generation: client/adr/0002-openapi-code-generation.md
          - ADR-003 Transparent Pagination: client/adr/0003-transparent-pagination.md
          - ADR-004 Defer Observability to httpx: client/adr/0004-defer-observability-to-httpx.md
          - ADR-005 Sync and Async APIs: client/adr/0005-sync-async-apis.md
          - ADR-006 Response Unwrapping Utilities: client/adr/0006-response-unwrapping-utilities.md
          - ADR-007 Domain Helper Classes: client/adr/0007-domain-helper-classes.md
          - ADR-008 Avoid Builder Pattern (Proposed): client/adr/0008-avoid-builder-pattern.md
          - ADR-011 Pydantic Domain Models: client/adr/0011-pydantic-domain-models.md
          - ADR-012 Validation Tiers: client/adr/0012-validation-tiers-for-agent-workflows.md
  - MCP Server:
      - Overview: mcp-server/index.md
      - Architecture: mcp-server/architecture.md
      - Development: mcp-server/development.md
      - Deployment: mcp-server/deployment.md
      - Docker: mcp-server/docker.md
      - Implementation Plan: mcp-server/implementation-plan.md
      - ADRs:
          - Overview: mcp-server/adr/README.md
          - ADR-010 Katana MCP Server: mcp-server/adr/0010-katana-mcp-server.md
  - API Reference: reference/
  - OpenAPI Documentation: openapi-docs.md
  - Development:
      - Contributing: CONTRIBUTING.md
      - uv Package Manager: UV_USAGE.md
      - Semantic Release: MONOREPO_SEMANTIC_RELEASE.md
      - PyPI Setup: PYPI_SETUP.md
      - Release Guide: RELEASE.md
  - Monorepo ADRs:
      - Overview: adr/README.md
      - ADR-009 Migrate to uv: adr/0009-migrate-from-poetry-to-uv.md
      - ADR-013 Module-Local Docs: adr/0013-module-local-documentation.md

extra:
  version:
    provider: mike
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/dougborg/katana-openapi-client
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/katana-openapi-client/

extra_css:
  - css/mkdocstrings.css