mkdocs.yml

site_name: "mkdocstrings-matlab"
site_description: "A MATLAB handler for mkdocstrings."
site_url: "https://watermarkhu.nl/mkdocstrings-matlab"
repo_url: "https://github.com/watermarkhu/mkdocstrings-matlab"
repo_name: "watermarkhu/mkdocstrings-matlab"
copyright: Copyright © 2025 Mark Shui Hu
edit_uri: edit/main/docs/

validation:
  omitted_files: warn
  absolute_links: warn
  unrecognized_links: warn

watch:
  - mkdocs.yml
  - docs
  - src

nav:
- Home:
  - Overview: index.md
  - Changelog: changelog.md
  - Contributing: contributing.md
  - Credits: credits.md
  - License: license-page.md
- Usage:
  - usage/index.md
  - Configuration options:
    - General: usage/configuration/general.md
    - Headings: usage/configuration/headings.md
    - Members: usage/configuration/members.md
    - Docstrings: usage/configuration/docstrings.md
    - Signatures: usage/configuration/signatures.md
  - Docstring styles:
    - Google: usage/docstrings/google.md
    - Numpy: usage/docstrings/numpy.md
    - Sphinx: usage/docstrings/sphinx.md
- API reference:
  - mkdocstrings_handlers:
    - matlab: api.md

- mkdocstrings: https://mkdocstrings.github.io/

theme:
  name: material
  logo: logo.png
  favicon: favicon.png
  custom_dir: docs/overrides
  features:
  - announce.dismiss
  - content.action.edit
  - content.action.view
  - content.code.annotate
  - content.code.copy
  - content.tooltips
  - navigation.footer
  - navigation.indexes
  - navigation.sections
  - navigation.tabs
  - navigation.tabs.sticky
  - navigation.top
  - search.highlight
  - search.suggest
  - toc.follow
  - toc.integrate
  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: matlab
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to system preference

extra_css:
  - stylesheets/extra.css

markdown_extensions:
- abbr
- attr_list
- admonition
- footnotes
- md_in_html
- pymdownx.blocks.admonition
- pymdownx.details
- pymdownx.blocks.tab:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
    use_pygments: true
    pygments_lang_class: true
- pymdownx.magiclink
- pymdownx.snippets:
    # auto_append: [docs/.glossary.md]
    base_path: [!relative $config_dir]
    check_paths: true
- pymdownx.superfences:
    custom_fences:
    - name: mermaid
      class: mermaid
      format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
    alternate_style: true
    slugify: !!python/object/apply:pymdownx.slugs.slugify
      kwds:
        case: lower
- pymdownx.tasklist:
    custom_checkbox: true
- toc:
    permalink: "¤"
    toc_depth: 3

plugins:
- callouts
- autorefs
- search
- markdown-exec
- mkdocstrings:
    default_handler: matlab
    handlers:
      matlab:
        paths: ["docs/src"]
        paths_recursive: true
        options:
          show_inheritance_diagram: false
          show_source: false
          heading_level: 3
          argument_headings: false
          show_root_heading: true
          show_root_toc_entry: false
          show_root_full_path: true
          show_root_members_full_path: false
          show_object_full_path: false
          show_category_heading: false
          show_symbol_type_heading: false
          show_symbol_type_toc: false

          hidden_members: false
          private_members: false
          inherited_members: false
          filters: ["!^delete$|^disp$"]
          members_order: "source"
          summary: false
          show_attributes: true

          docstring_style: google
          docstring_section_style: table
          parse_arguments: false
          merge_constructor_into_class: false
          show_if_no_docstring: false
          show_docstring_description: true
          show_docstring_examples: true
          show_docstring_input_arguments: true
          show_docstring_name_value_arguments: true
          show_docstring_output_arguments: true

          show_signature: true
          show_signature_types: false
          separate_signature: false 
      python:
        paths: [src]
        inventories:
        - https://docs.python.org/3/objects.inv
        options:
          docstring_options:
            ignore_init_summary: true
          docstring_section_style: list
          filters: ["!^_"]
          heading_level: 1
          inherited_members: true
          merge_init_into_class: true
          parameter_headings: true
          relative_crossrefs: true
          scoped_crossrefs: true
          separate_signature: true
          show_bases: false
          show_inheritance_diagram: true
          show_root_heading: true
          show_root_full_path: false
          show_signature_annotations: true
          show_source: false
          show_symbol_type_heading: true
          show_symbol_type_toc: true
          signature_crossrefs: true
          summary: true
          unwrap_annotated: true

- minify:
    minify_html: !ENV [DEPLOY, false]

- git-revision-date-localized:
    enabled: !ENV [DEPLOY, false]
    enable_creation_date: true
    type: timeago

extra:
  version:
    provider: mike
    alias: true