mkdocs.yml

site_name: tcpb-client
theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light-green
      accent: cyan
      toggle:
        icon: material/lightbulb
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: light-green
      accent: cyan
      toggle:
        icon: material/lightbulb-outline
        name: Switch to light mode
  features:
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - announce.dismiss
    - navigation.tabs
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.preview
    - navigation.instant.progress
    - navigation.path
    - navigation.sections
    - navigation.top
    - navigation.tracking
    - search.suggest
    - toc.follow

repo_url: https://github.com/mtzgroup/tcpb-client
edit_uri: edit/develop/docs/
site_author: Colton Hicks
extra_css:
  - css/extra.css
plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            members_order: source
            separate_signature: true
            show_bases: false
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            merge_init_into_class: true
            show_signature_annotations: true
            signature_crossrefs: true
            inherited_members: false
            # Pretty sure I want this false.
            show_if_no_docstring: false

            docstring_options:
              ignore_init_summary: true

            filters:
              - "!^_"
              - "!^model"
              - "^__init__"

          selection:
            new_path_syntax: true

markdown_extensions:
  - toc:
      permalink: true
      title: Page contents
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      pygments_lang_class: true
  - pymdownx.extra
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tabbed:
      alternate_style: true
  - markdown_include.include:
      base_path: docs

watch:
  - tcpb