mkdocs.yml

site_name: python-trueconf-bot
site_description: TrueConf Chatbot Library for Python 3 with Websocket & Asyncio
site_author: TrueConf LLC
repo_url: https://github.com/trueconf/python-trueconf-bot/
site_url: https://trueconf.github.io/python-trueconf-bot/
copyright: >
  Copyright © 2026 – TrueConf LLC. All rights reserved
  |
  <a href="https://trueconf.github.io/python-trueconf-bot/master/llms.txt">llms.txt</a>
  |
  <a href="https://trueconf.github.io/python-trueconf-bot/master/llms-full.txt">llms-full.txt</a>

theme:
  language: en
  name: "material"
  font:
    text: Roboto
    code: Roboto Mono
  custom_dir: docs/overrides
  palette:

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

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

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

  icon:
    repo: fontawesome/brands/github
  logo: img/logo.svg
  favicon: img/favicon.ico

  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
#    - navigation.instant
#    - navigation.instant.prefetch
#    - navigation.instant.progress
    - navigation.path
    - navigation.sections
    # - navigation.expand
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

plugins:
  - mike
  - autorefs:
      resolve_closest: true
  - macros
  - mkdocstrings:
        handlers:
          python:
            options:
              extensions:
                - griffe_typingdoc

              # basic
              show_source: false
              show_bases: false
              show_root_heading: true
              show_if_no_docstring: true
              inherited_members: true
              members_order: alphabetical
              separate_signature: true
              unwrap_annotated: true
              filters:
                - "!^_"
                - "!^__"
              merge_init_into_class: true
              docstring_style: google
              docstring_section_style: table
              signature_crossrefs: true

              # "Attributes" and "Methods"
              group_by_category: true
              show_category_heading: false
              show_symbol_type_heading: true
              show_symbol_type_toc: true

              extra:
                show_category_members: true
                show_inheritance: true

  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  - i18n:
      docs_structure: folder
      fallback_to_default: true
      languages:
        - locale: en
          name: English
          default: true
          build: true
          extra:
            social:
              - icon: fontawesome/brands/github
                link: https://github.com/trueconf
              - icon: fontawesome/brands/discord
                link: https://discord.gg/v4jqKQpq
              - icon: fontawesome/brands/telegram
                link: https://t.me/trueconf_chat
              - icon: fontawesome/brands/facebook
                link: https://www.facebook.com/trueconf/

        - locale: ru
          name: Русский
          build: true
          nav_translations:
            Learn: Обучение
            Features: Возможности
            Home: Главная
            Reference: Описание библиотеки
            Examples: Примеры кода
            Release Notes: Список изменений
          extra:
            social:
              - icon: fontawesome/brands/github
                link: https://github.com/trueconf
              - icon: fontawesome/brands/telegram
                link: https://t.me/trueconf_talks
              - icon: fontawesome/brands/vk
                link: https://vk.com/trueconf_club

nav:
  - Home: index.md
  - Features: features.md
  - Learn:
      - learn/getting-started.md
      - learn/parse-messages.md
      - learn/filters.md
      - learn/shortcuts.md
      - learn/enums.md
      - learn/types.md
      - learn/files.md
      - learn/restrictions.md
  - Reference:
      - reference/Bot.md
      - reference/Router.md
      - reference/Dispatcher.md
      - reference/Enums.md
      - reference/Types.md
      - reference/Exceptions.md
  - Examples: examples/index.md
  - Release Notes: release_notes.md



markdown_extensions:
  # Python Markdown
  - abbr
  - admonition
  - attr_list
  - footnotes
  - md_in_html
  - codehilite
  - pymdownx.highlight:
      anchor_linenums: true
      linenums_style: table
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.critic
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.magiclink:
      hide_protocol: true
      repo_url_shorthand: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: ⚓︎

extra_css:
  - stylesheets/extra.css

extra:
  version:
    provider: mike
  product_name: "python-trueconf-bot"
  product_server: "TrueConf Server"
  product_chatbot: "TrueConf Chatbot Connector"
  generator: false
  analytics:
    provider: google
    property: G-HYJY7RVTQR

hooks:
  - docs/hooks/llms_txt.py