mkdocs.yml

#file: noinspection SpellCheckingInspection
site_name: PyDGLab-WS
site_url: https://pydglab-ws.readthedocs.io/
site_description: 郊狼 Socket 开发库 PyDGLab-WS 文档
repo_url: https://github.com/Ljzd-PRO/PyDGLab-WS
repo_name: Ljzd-PRO/PyDGLab-WS
copyright: Copyright © 2024 by Ljzd-PRO

watch:
  - pydglab_ws
  - examples

nav:
  - Get Started:
    - Welcome to PyDG-Lab-WS: index.md
    - About DG-Lab: about-dg-lab.md
    - More: more.md
  - Usage:
    - Server: usage/server.md
    - Client:
        - Base: usage/client/base.md
        - WebSocket Client: usage/client/ws.md
        - Server With Local Client: usage/client/local.md
  - Examples:
    - Server: examples/server.md
    - WebSocket Client: examples/ws-client.md
    - Server With Local Client: examples/server-with-local-client.md
    - Add Pulses: examples/add-pulses.md
  - API Documentation:
    - Client:
        - DGLabClient: api/client/base.md
        - DGLabLocalClient: api/client/local.md
        - DGLabWSClient: api/client/ws.md
        - DGLabWSConnect: api/client/connect.md
    - Server:
        - DGLabWSServer: api/server/server.md
    - Base:
      - enums: api/enums.md
      - exceptions: api/exceptions.md
      - models: api/models.md
      - typing: api/typing.md
      - utils: api/utils.md
  - FAQ: faq.md

plugins:
  - tags
  - search
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
          options:
            docstring_style: sphinx
            find_stubs_package: true
            members_order: source
            separate_signature: true
            docstring_options:
              ignore_init_summary: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
  - i18n:
      docs_structure: folder
      languages:
        - locale: zh
          name: 中文（简体）
          default: true

          nav_translations:
            Get Started: 开始
            Welcome to PyDG-Lab-WS: 欢迎使用 PyDG-Lab-WS
            About DG-Lab: 关于 DG-Lab
            More: 更多
            Usage: 用法
            Examples: 演示示例
            Server: 服务端
            WebSocket Client: WebSocket 终端
            Server With Local Client: 与本地终端一体的服务端
            Add Pulses: 发送波形
            API Documentation: API 文档
            FAQ: 常见问题
            Base: 基础
            enums: 枚举
            exceptions: 异常
            models: 数据模型
            typing: 自定义类型
            utils: 工具函数
            Client: 客户端
            DGLabClient: DG-Lab 终端
            DGLabLocalClient: DG-Lab 本地终端
            DGLabWSClient: DG-Lab WebSocket 终端
            DGLabWSConnect: DG-Lab WebSocket 终端连接器
            DGLabWSServer: DG-Lab WebSocket 服务端

          site_description: "PyDG-Lab-WS 文档"

          theme:
            palette:
              - media: "(prefers-color-scheme)"
                toggle:
                  icon: material/brightness-auto
                  name: 切换至深色模式
              - media: "(prefers-color-scheme: light)"
                scheme: default
                toggle:
                  icon: material/brightness-7
                  name: 切换至自动
              - media: "(prefers-color-scheme: dark)"
                scheme: slate
                toggle:
                  icon: material/brightness-4
                  name: 切换至浅色模式
            features:
              - content.code.annotate
          extra:
            analytics:
              provider: google
              property: G-E2Y6VTZJZN
              feedback:
                title: 这个页面对你有帮助吗？
                ratings:
                  - icon: material/emoticon-happy-outline
                    name: 这个页面有帮助
                    data: 1
                    note: >-
                      感谢你的反馈！
                  - icon: material/emoticon-sad-outline
                    name: 这个页面可以改进
                    data: 0
                    note: >-
                      感谢你的反馈，你可以前往我们 GitHub 仓库 Issues 或 Discussion 页面提交更多建议！

theme:
  name: material
  features:
    - search.suggest
    - search.highlight
    - search.share
    - navigation.tracking
    - navigation.tabs
    - navigation.path
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - content.action.edit
  palette:

    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to system preference

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

extra:
  version:
    provider: mike
  analytics:
    provider: google
    property: G-E2Y6VTZJZN
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/emoticon-happy-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/emoticon-sad-outline
          name: This page could be improved
          data: 0
          note: >-
            Thanks for your feedback! You can submit more advice on Issues or Discussion page of our GitHub Repository.

markdown_extensions:

  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true

  # Python Markdown Extensions
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde
  - pymdownx.snippets