mkdocs.yml

site_name: runningman

theme:
  name: "material"
  logo: assets/logo.jpg
  favicon: assets/logo.jpg
  features:
    - navigation.instant
    - navigation.path
    - navigation.top
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: "#002d72"
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode

    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: "#002d72"
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
  icon:
    repo: fontawesome/brands/github


repo_url: https://github.com/danielk333/runningman

extra_css:
  - assets/style.css

plugins:
  - search
  - section-index
  - gen-files:
      scripts:
        - scripts/generate_api_docs.py
  - literate-nav:
      nav_file: nav.md
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            docstring_section_style: table
            show_docstring_functions: true
            show_docstring_modules: true
            show_docstring_description: true
  - mkdocs-jupyter:
      execute: false
      include_source: True
      ignore: ["_wip*"]

nav:
  - Home: index.md
  - Getting started: getting_started.md
  - Examples:
    - examples/index.md
    - network_control: examples/network_control.py
    - network_trigger: examples/network_trigger.py
    - timed_triggered_service: examples/timed_triggered_service.py
    - triggered_provider_with_service: examples/triggered_provider_with_service.py
    - watch_folder_provider: examples/watch_folder_provider.py
  - Reference: reference/