mkdocs.yml

site_name: App Model
site_url: https://github.com/pyapp-kit/app-model
site_author: Talley Lambert
site_description: Generic application schema implemented in python.
# strict: true

repo_name: pyapp-kit/app-model
repo_url: https://github.com/pyapp-kit/app-model

copyright: Copyright © 2021 - 2023 Talley Lambert

watch:
  - src

nav:
  - index.md
  - getting_started.md
  # defer to gen-files + literate-nav
  - API reference: reference/

plugins:
  - search
  - gen-files:
      scripts:
        - docs/gen_ref_nav.py
  - literate-nav:
      nav_file: SUMMARY.txt
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          import:
            - https://docs.python.org/3/objects.inv
            - https://ino.readthedocs.io/en/latest/objects.inv
          options:
            extensions:
              - griffe_fieldz
            docstring_style: numpy
            docstring_options:
              ignore_init_summary: true
            docstring_section_style: list
            filters: ["!^_"]
            heading_level: 1
            inherited_members: true
            merge_init_into_class: true
            separate_signature: true
            show_root_heading: true
            show_root_full_path: false
            show_signature_annotations: true
            show_bases: true
            show_source: true

markdown_extensions:
  - tables
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - admonition
  - toc:
      permalink: "#"
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

theme:
  name: material
  icon:
    repo: material/github
    logo: material/application-cog-outline
  features:
    - navigation.instant
    - navigation.indexes
    - search.highlight
    - search.suggest
    - navigation.expand

extra_css:
  - css/style.css

hooks:
  - docs/my_hooks.py