mt5cli/mkdocs.yml

site_name: mt5cli API Documentation
site_description: Generic MT5 data and execution infrastructure for Python
site_author: dceoy
site_url: https://github.com/dceoy/mt5cli

repo_name: dceoy/mt5cli
repo_url: https://github.com/dceoy/mt5cli

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - content.code.mermaid
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [.]
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            docstring_style: google
            docstring_section_style: table
            separate_signature: true
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            show_if_no_docstring: true

nav:
  - Home: index.md
  - API Reference:
      - Overview: api/index.md
      - Public API Contract: api/public-contract.md
      - Client: api/client.md
      - Schemas: api/schemas.md
      - Converters: api/converters.md
      - Exceptions: api/exceptions.md
      - CLI: api/cli.md
      - SDK: api/sdk.md
      - Trading: api/trading.md
      - History Collection (SQLite): api/history.md
      - Telemetry: api/telemetry.md
      - Grafana: api/grafana.md
      - Utils: api/utils.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true