mkdocs.yaml

site_name: Grayven
site_url: https://grayven.readthedocs.io/en/latest/
site_description: A Python wrapper for the Grand Comics Database API.
site_author: Jonah Jackson

copyright: MIT

repo_url: https://github.com/Metron-Project/Grayven
repo_name: Metron-Project/Grayven

theme:
  name: material
  features:
    - content.code.copy
    - navigation.expand
    - navigation.top
  icon:
    repo: material/github
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode

extra:
  social:
    - icon: material/github
      link: https://github.com/Metron-Project
    - icon: material/language-python
      link: https://pypi.org/project/Grayven/
    - icon: material/mastodon
      link: https://mastodon.social/@metron
    - icon: simple/matrix
      link: https://matrix.to/#/#metron-general:matrix.org

markdown_extensions:
  - pymdownx.highlight:
      auto_title: true
  - pymdownx.inlinehilite
  - pymdownx.superfences


nav:
  - Home: index.md
  - grayven:
      - Package: grayven/__init__.md
      - exceptions: grayven/exceptions.md
      - grand_comics_database: grayven/grand_comics_database.md
      - sqlite_cache: grayven/sqlite_cache.md
  - grayven.schemas:
      - Package: grayven/schemas/__init__.md
      - issue: grayven/schemas/issue.md
      - publisher: grayven/schemas/publisher.md
      - series: grayven/schemas/series.md

plugins:
  - search
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          options:
            show_root_heading: True
            show_root_full_path: False
            show_category_heading: True
            # Docstrings
            docstring_style: google
            docstring_section_style: spacy
            line_length: 100
            merge_init_into_class: True
            show_signature_annotations: True
            # Additional
            show_source: False
  - include-markdown