mkdocs.yml

site_name: AAct
site_description: AAct is a Python library for building asynchronous communicative actors.
strict: true
site_url: https://aact.dev/
repo_url: https://github.com/ProKil/aact
repo_name: ProKil/aact

theme:
  name: "material"
  logo: assets/aact.svg
  favicon: assets/favicon.svg
  icon:
    repo: fontawesome/brands/github
  palette:
  - media: "(prefers-color-scheme)"
    scheme: default
    primary: deep purple
    accent: amber
    toggle:
      icon: material/lightbulb
      name: "Switch to light mode"
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: deep purple
    accent: amber
    toggle:
      icon: material/lightbulb-outline
      name: "Switch to dark mode"
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: deep purple
    accent: amber
    toggle:
      icon: material/lightbulb-auto-outline
      name: "Switch to system preference"
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - toc.follow

extra:
  version:
    provider: mike
  analytics:
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback!
nav:
- Get Started:
  - Welcome to AAct: index.md
  - Why use AAct: why.md
  - Installation: install.md
- Usage:
    usage.md
- API Documentation:
  - AAct:
    - Nodes: api/nodes.md
    - Messages: api/messages.md
  - AAct CLI:
    - Commands: api/cli.md
- Applications:
  - Robotics:
    - Robot Teleoperation: applications/robot-teleoperation.md

plugins:
- social
- search
- mike:
    alias_type: symlink
    canonical_version: latest
- exclude:
    glob:
    - theme/announce.html
    - plugins/*
    - __pycache__/*
- mkdocstrings:
    handlers:
      python:
        paths: [.]
        options:
          members_order: source
          separate_signature: true
          filters: ["!^_"]
          docstring_options:
            ignore_init_summary: true
          merge_init_into_class: true
          show_signature_annotations: true
          signature_crossrefs: true
          extensions:
            - docs/plugins/griffe_doclinks.py
        import:
          - url: https://docs.python.org/3/objects.inv
            domains: [py, std]