site_name: "Manta Documentation"
site_description: Manta Documentation
site_author: Fischer Moseley
site_url: https://fischermoseley.github.io/manta/

repo_url: https://github.com/fischermoseley/manta/
repo_name: fischermoseley/manta
docs_dir: 'doc'

theme:
  name: material
  logo: assets/logo_minimal_border.png
  favicon: assets/logo_ray_only_with_shadow.png
  custom_dir: doc/overrides/
  features:
    - content.code.copy
    - content.code.annotate
    - navigation.sections
    - navigation.expand

  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-7
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: blue
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: custom
      toggle:
        icon: material/brightness-auto
        name: Switch to system preference

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tilde
  - attr_list

extra:
  version:
    provider: mike

plugins:
  - mkdocstrings:
      handlers:
        python:
          options:
            merge_init_into_class: true
            heading_level: 3
            show_bases: false
            show_root_heading: true
            show_source: false
            separate_signature: true
            show_signature_annotations: true
            modernize_annotations: true
            signature_crossrefs: true
            docstring_section_style: list
            show_symbol_type_toc: true
            show_symbol_type_heading: true

            docstring_options:
              ignore_init_summary: false

            # filters: ["!^_"]
            unwrap_annotated: true

nav:
    - Home: index.md
    - Installation: installation.md
    - Getting Started: getting_started.md
    - Use Cases: use_cases.md
    - Architecture: architecture.md
    - Similar Tools: similar_tools.md
    - Cores:
      - IO Core: io_core.md
      - Logic Analyzer Core: logic_analyzer_core.md
      - Memory Core: memory_core.md

    - Interfaces:
      - UART Interface: uart_interface.md
      - Ethernet Interface: ethernet_interface.md
    - For Developers:
      - Roadmap: https://github.com/fischermoseley/manta/milestones