mkdocs.yml

site_name: RavyAPI.py Docs

copyright: Copyright © 2022-Present GoogolGenius

repo_url: https://github.com/GoogolGenius/ravyapi.py
repo_name: GoogolGenius/RavyAPI.py

edit_uri: edit/main/docs/

theme:
  name: material
  features:
    - navigation.expand
    - navigation.tabs
    - navigation.top
    - search.share
    - search.suggest
    - toc.integrate
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          selection:
            docstring_style: numpy
            inherited_members: true
          rendering:
            docstring_section_style: spacy
            show_signature_annotations: true
            show_source: false
      watch:
        - ravyapi

markdown_extensions:
  - admonition
  - attr_list
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tilde
  - toc:
      permalink: true