mkdocs.yml

site_name: dgpy-libs
docs_dir: docs
site_dir: public
site_url: ''
repo_url: 'https://github.com/dynamic-graphics-inc/dgpy-libs/'
repo_name: 'GitHub'
site_author: 'jesse rubin <jesse@dgi.com> & dan costello <dan@dgi.com>'
copyright: 'Dynamic Graphics Inc'
remote_branch: 'gh-pages'
watch:
  - libs/aiopen/src/aiopen
  - libs/asyncify/src/asyncify
  - libs/fmts/src/fmts
  - libs/funkify/src/funkify
  - libs/h5/src/h5
  - libs/jsonbourne/src/jsonbourne
  - libs/listless/src/listless
  - libs/requires/src/requires
  - libs/shellfish/src/shellfish
  - libs/xtyping/src/xtyping


nav:
  # - Home: './index.md'
  - Libs:
      - Home: './index.md'
      - aiopen: './libs/aiopen/README.ipynb'
      - asyncify: './libs/asyncify/README.ipynb'
      - funkify: './libs/funkify/README.ipynb'
      - h5: './libs/h5/README.ipynb'
      - jsonbourne: './libs/jsonbourne/README.ipynb'
      - lager: './libs/lager/README.ipynb'
      - requires: './libs/requires/README.ipynb'
      - xtyping: './libs/xtyping/README.ipynb'
  - API:
      - aiopen: './libs/aiopen/aiopen.api.md'
      - asyncify: './libs/asyncify/asyncify.api.md'
      - fmts: './libs/fmts/fmts.api.md'
      - funkify: './libs/funkify/funkify.api.md'
      - h5: './libs/h5/h5.api.md'
      - requires: './libs/requires/requires.api.md'
      - listless: './libs/listless/listless.api.md'
      - jsonbourne: './libs/jsonbourne/jsonbourne.api.md'
      - shellfish: './libs/shellfish/shellfish.api.md'
      - xtyping: './libs/xtyping/xtyping.api.md'
  # - Notebooks:
  #     - Cache Money: './notebooks/cache_money.ipynb'
  #     - Filter None: './notebooks/filter_none.ipynb'
  #     - JSON "parsing": './notebooks/json_parsing.ipynb'
  #     - String Formatting: './notebooks/string_fmt.ipynb'

theme:
  name: 'material'
  logo: 'images/dgpy_white_edge_small.png'
  favicon: images/favicon.png

  icon:
    repo: fontawesome/brands/github-alt
  font:
    text: 'Roboto'
    code: 'Roboto Mono'
  palette:
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: deep purple
      accent: teal
      toggle:
        icon: material/weather-night
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: teal
      accent: deep purple
      toggle:
        icon: material/weather-sunny
        name: Switch to dark mode
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - navigation.expand
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - search
    - search.highlight
    - search.suggest
    - toc.follow
    - toc.integrate

markdown_extensions:
  - attr_list
  - admonition
  - callouts
  - footnotes
  - pymdownx.details
  - pymdownx.emoji
  - pymdownx.tilde
  - pymdownx.magiclink
  - pymdownx.escapeall
  - pymdownx.highlight
  - pymdownx.superfences
  - pymdownx.snippets
  - pymdownx.inlinehilite
  - pymdownx.tasklist
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.betterem:
      smart_enable: all
  - toc:
      permalink: ⚓︎

plugins:
  - search:
      lang: en
  - mkdocs-jupyter:
      execute: false
  ### MKDOCSTRINGS ###
  - mkdocstrings:
      handlers:
        python:
          paths:
            - libs/aiopen
            - libs/asyncify
            - libs/fmts
            - libs/funkify
            - libs/h5
            - libs/jsonbourne
            - libs/requires
            - libs/listless
            - libs/shellfish
            - libs/xtyping
          # setup_commands:
          #   - import sys
          #   - from os import path
          #   - sys.path.append("docs")
          #   - sys.path.append(path.join("libs", "aiopen"))
          #   - sys.path.append(path.join("libs", "asyncify"))
          #   - sys.path.append(path.join("libs", "dgpylibs"))
          #   - sys.path.append(path.join("libs", "dgpytest"))
          #   - sys.path.append(path.join("libs", "fmts"))
          #   - sys.path.append(path.join("libs", "funkify"))
          #   - sys.path.append(path.join("libs", "h5"))
          #   - sys.path.append(path.join("libs", "jsonbourne"))
          #   - sys.path.append(path.join("libs", "lager"))
          #   - sys.path.append(path.join("libs", "listless"))
          #   - sys.path.append(path.join("libs", "shellfish"))
          #   - sys.path.append(path.join("libs", "xtyping"))
          inherited_members: true
          docstring_style: google
          options:
            docstring_options:
              ignore_init_summary: true
            heading_level: 2
            inherited_members: true
            merge_init_into_class: true
            new_path_syntax: false
            separate_signature: false
            show_category_heading: true
            show_object_full_path: true
            show_root_full_path: true
            show_root_heading: true
            show_root_members_full_path: true
            show_signature_annotations: true
            show_source: true
            show_submodules: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            signature_crossrefs: true
            filters:
              - "!^_"  # exclude all members starting with _
              - "^__init__$"  # but always include __init__ modules and methods
              - "^__.*__$"  # include all dunder methods