mkdocs.yml

site_name: QQMusicApi
site_description: 使用 Python 编写的用于调用 QQ音乐 各种 API 的库.

theme:
  name: "material"
  language: zh
  font: false
  icon:
    repo: fontawesome/brands/github
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.instant
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - navigation.indexes
    - search.suggest
    - toc.follow
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/theme-light-dark
        name: Automatically Switch ui mode
    - media: "(prefers-color-scheme: light)"
      scheme: latte
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: macchiato
      toggle:
        icon: material/weather-night
        name: Switch to light mode

repo_name: luren-dc/QQMusicApi
repo_url: https://github.com/luren-dc/QQMusicApi
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/luren-dc/QQMusicApi

extra_css:
  - css/font.css
  - css/scheme.css
  - https://fonts.loli.net/css2?family=Noto+Serif+SC&display=swap

markdown_extensions:
  - nl2br
  - abbr
  - attr_list
  - admonition
  - def_list
  - footnotes
  - md_in_html
  - markdown_callouts.github_callouts
  - toc:
      slugify:
        !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
      permalink: ""
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.caret
  - pymdownx.blocks.admonition
  - pymdownx.blocks.details
  - pymdownx.blocks.html
  - pymdownx.blocks.definition
  - pymdownx.blocks.tab:
      alternate_style: True
      combine_header_slug: True
      slugify:
        !!python/object/apply:pymdownx.slugs.slugify { kwds: { case: lower } }
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.critic
  - pymdownx.smartsymbols
  - pymdownx.superfences
  - pymdownx.snippets:
      url_download: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

plugins:
  - search:
      lang: zh
  - mkdocstrings:
      handlers:
        python:
          paths: [., qqmusic_api]
          options:
            members_order: source
            separate_signature: true
            group_by_category: false
            show_root_heading: true
            show_symbol_type_heading: true
            heading_level: 1
            filters: ["!^_"]
            show_signature_annotations: true
            signature_crossrefs: true
            merge_init_into_class: true
            docstring_section_style: spacy
            extensions:
              - griffe_inherited_docstrings
              - docstring_inheritance.griffe
              - griffe_modernized_annotations
          import:
            - https://docs.python.org/3/objects.inv

nav:
  - 主页: index.md
  - 指南:
    - Logging: logging.md
    - Session: session.md
    - 凭证（Cookie）: credential.md
  - API 示例:
      - 登录: examples/login.md
      - 搜索: examples/search.md
      - 歌曲: examples/song.md
      - 用户: examples/user.md
      - 同步执行: examples/sync.md
  - API 文档:
      - utils:
          - common: api/utils/common.md
          - qimei: api/utils/qimei.md
          - network: api/utils/network.md
          - credential: api/utils/credential.md
          - session: api/utils/session.md
          - sync: api/utils/sync.md
          - tripledes: api/utils/tripledes.md
      - album: api/album.md
      - login: api/login.md
      - login_utils: api/login_utils.md
      - mv: api/mv.md
      - search: api/search.md
      - singer: api/singer.md
      - song: api/song.md
      - songlist: api/songlist.md
      - top: api/top.md
      - lyric: api/lyric.md
      - user: api/user.md
      - exceptions: api/exceptions.md
  - 贡献指南: contributing.md
  - Release Notes: release-notes.md

watch:
  - qqmusic_api
  - README.md
  - examples