mkdocs.yaml

site_name: Docstring Format Checker
site_description: A Python CLI tool that validates docstring formatting and completeness using AST parsing. Configure validation rules via TOML and ensure consistent documentation across your codebase.
site_author: "[Chris Mahoney](mailto:chris@mahoneyconsultingservices.com)"
site_dir: web
docs_dir: docs
remote_branch: docs-site
repo_name: docstring-format-checker
repo_url: https://github.com/data-science-extensions/docstring-format-checker
edit_uri: edit/main/docs/

watch:
  - src/docstring_format_checker
  - docs/
  - README.md

theme:
  name: material
  favicon: ./assets/icons/1589516.svg
  coverpage_icon: ./assets/icons/1589516.svg
  coverpage_icon_source: https://www.flaticon.com/free-icon/coding_1589516
  custom_dir: docs/overrides
  palette:
    primary: blue grey
    accent: indigo
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.indexes
    - navigation.top
    - navigation.instant
    - search.highlight
    - search.suggest
    - toc.follow
    - content.action.edit
    - content.action.view
    - content.code.select
    - content.code.copy
    - content.code.annotate
  logo: ./assets/icons/1589516.svg
  icon:
    repo: material/github
    edit: material/file-edit-outline
    view: material/file-eye-outline
  font:
    code: Consolas, 'Courier New', monospace

hooks:
  - docs/overrides/hooks/shortcodes.py

nav:
  - Home: index.md
  - Usage:
      - Overview: usage/overview.md
      - Basic:
        - Getting Started: usage/getting_started.md
        - FAQ: usage/faq.md
      - Advanced:
        - Configuration: usage/configuration.md
        - CLI: usage/command_line_interface.md
      - General:
        - Contributing: usage/contributing.md
        - Change Log: usage/changelog.md
        - License: usage/license.md
  - Modules:
      - code/index.md
      - CLI: code/cli.md
      - Config: code/config.md
      - Core: code/core.md
      - Exceptions: code/exceptions.md
  - Data Science Extensions: https://data-science-extensions.com/


markdown_extensions:
  - admonition
  - meta
  - attr_list
  - md_in_html
  - toc:
      permalink: "🔗"
  - pymdownx.emoji
  - pymdownx.magiclink
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.progressbar
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

extra:
  version:
    provider: mike
    default: latest

extra_css:
  - assets/stylesheets/style.css
  - assets/stylesheets/admonitions.css
  - assets/stylesheets/code_chunks.css
  - assets/stylesheets/shortcodes.css
  - https://site-assets.fontawesome.com/releases/v6.4.2/css/all.css

plugins:
  - search:
      lang: en
  - autorefs
  - mike:
      version_selector: true
      alias_type: copy
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths:
            - src
          options:
            # extensions:
            #   - griffe_inherited_docstrings
            #   - docstring_inheritance.griffe
            allow_inspection: true
            docstring_style: google
            show_root_heading: true
            show_root_toc_entry: false
            show_root_full_path: true
            show_source: true
            show_object_full_path: false
            separate_signature: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            show_category_heading: true
            show_if_no_docstring: true
            heading_level: 3
            members_order: source
            group_by_category: false
            filters:
              - "!^__all__"