hikari-py/hikari

site_name: hikari
site_url: https://docs.hikari-py.dev/
site_dir: public/docs

repo_url: https://github.com/hikari-py/hikari/
repo_name: hikari-py/hikari
edit_uri: blob/master/docs/

watch: [ hikari, README.md, CHANGELOG.md ]
copyright: © 2021-present davfsa

#strict: true

theme:
  name: material
  font:
    code: JetBrains Mono

  logo: logo.png
  favicon: logo.png

  icon:
    repo: fontawesome/brands/github
    edit: material/pencil
    view: material/eye
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode

    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: deep purple
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode

  features:
    - content.tabs.link
    - search.highlight
    - search.suggest
    - search.share
    - content.action.edit
    - navigation.tabs
    - navigation.indexes
    - navigation.top
    - toc.follow

markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - toc:
      permalink: "#"

  # Python Markdown Extensions
  - pymdownx.snippets
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.superfences
  - pymdownx.tilde
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true

plugins:
  - autorefs
  - search
  - minify:
      minify_html: true
      htmlmin_opts:
          remove_comments: true
      cache_safe: true
#  - glightbox:
#      touchNavigation: true
#      loop: false
#      effect: zoom
#      slide_effect: slide
#      width: 100%
#      height: auto
#      zoomable: true
#      draggable: true
#      auto_caption: false
#      caption_position: bottom
#      skip_classes:
#         - no-lightbox
  - gen-files:
      scripts:
      - docs/gen_ref_pages.py
  - literate-nav:
      nav_file: summary.md
  - mkdocstrings:
      enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
      default_handler: python
      enable_inventory: true
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://docs.aiohttp.org/en/stable/objects.inv
            - https://www.attrs.org/en/stable/objects.inv
            - https://multidict.readthedocs.io/en/stable/objects.inv
            - https://yarl.readthedocs.io/en/stable/objects.inv
          options:
            filters: ["!^_"]
            heading_level: 3
            annotations_path: brief
            docstring_section_style: spacy
            docstring_style: numpy
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_signature_annotations: true
            show_source: false
            show_submodules: false
            signature_crossrefs: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
#            show_root_toc_entry: false
            line_length: 80
            extensions:
                - griffe_inherited_docstrings