mkdocs.yml

# Building Locally:
# Run: pip install mkdocs mkdocs-material mkdocstrings[python] mkdocs-material-extensions
# Run: mkdocs serve
# Open: http://localhost:8000/plankapy/

site_name: Plankapy
site_url: https://hwelch-fle.github.io/plankapy
repo_url: https://github.com/hwelch-fle/plankapy

theme:
  name: material
  #custom_dir: overrides
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/lightbulb-auto
      name: Switch to light mode
  - media: '(prefers-color-scheme: light)'
    scheme: default
    primary: teal
    accent: amber
    toggle:
      icon: material/lightbulb
      name: Switch to dark mode
  - media: '(prefers-color-scheme: dark)'
    scheme: slate
    primary: teal
    accent: amber
    toggle:
      icon: material/lightbulb-outline
      name: Switch to system preference
  features:
    - announce.dismiss
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.footnote.tooltips
    - content.tabs.link
    - content.tooltips
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow

markdown_extensions:
  # Python Markdown
  abbr:
  attr_list:
  footnotes:
  md_in_html:
  tables:
  toc:
    permalink: true

  # Python Markdown Extensions
  pymdownx.betterem:
    smart_enable: all
  pymdownx.caret:
  pymdownx.highlight:
    line_spans: __span
  pymdownx.inlinehilite:
  pymdownx.keys:
  pymdownx.mark:
  pymdownx.snippets:
  pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
  pymdownx.tilde:

  # pymdownx blocks
  pymdownx.blocks.admonition:
    types:
    - note
    - attention
    - caution
    - danger
    - error
    - tip
    - hint
    - warning
    # Custom types
    - info
    - check
  pymdownx.blocks.details:
  pymdownx.blocks.tab:
    alternate_style: True

extra:
  mkdocstrings:
    default_handler: python
    handlers:
      python:
        docstring_style: google
        options:
          show_root_heading: true
          show_if_no_docstring: true
          inherited_members: true
          members_order: source
          separate_signature: true
          filters:
          - '!^_'
          merge_init_into_class: true
          signature_crossrefs: true
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          rendering:
            show_source: false
          selection:
            docstring_style: google

nav:
  - Home: index.md
  - API: 
    - QueryableList: models/QueryableList.md
    - Planka: interfaces/Planka.md
    - Authentication Interfaces:
      - PasswordAuth: auth/PasswordAuth.md
      - TokenAuth: auth/TokenAuth.md
    - User Interfaces:
      - User: interfaces/User.md
      - Notification: interfaces/Notification.md
    - Project Interfaces: 
      - Project: interfaces/Project.md
      - ProjectManager: interfaces/ProjectManager.md
    - Board Interfaces: 
      - Board: interfaces/Board.md
      - BoardMembership: interfaces/BoardMembership.md
      - Label: interfaces/Label.md
      - List: interfaces/List.md
    - Card Interfaces:
      - Card: interfaces/Card.md
      - CardLabel: interfaces/CardLabel.md
      - CardMembership: interfaces/CardMembership.md
      - CardSubscription: interfaces/CardSubscription.md
      - Attachment: interfaces/Attachment.md
      - Action: interfaces/Action.md
      - Task: interfaces/Task.md
      - Stopwatch: interfaces/Stopwatch.md
    - Constants: constants/constants.md
    - Helpers: helpers/helpers.md
    #- Models: models/models.md

    - Unused:
      - IdentityProviderUser: interfaces/IdentityProviderUser.md
      - Archive: interfaces/Archive.md

  #- CLI: cli/cli.md
  - Examples: examples.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
  - autorefs