mkdocs.yml

site_name: dature
site_url: https://dature.readthedocs.io/
site_description: Type-safe configuration loader for Python dataclasses
site_author: Niccolum

repo_name: reagento/dature
repo_url: https://github.com/reagento/dature

copyright: Copyright © 2026-2026 Niccolum

theme:
  name: material
  font:
    text: Inter
    code: Roboto Mono
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  favicon: assets/img/logo.svg
  features:
    - navigation.instant
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.indexes
    - navigation.tracking
    - navigation.prune
    - navigation.top
    - navigation.footer
    - content.code.copy
    - content.code.annotate
    - content.tabs.link
    - search.suggest
    - search.highlight
  logo: assets/img/logo.svg
  icon:
    repo: fontawesome/brands/github
  custom_dir: docs/overrides

nav:
  - Getting Started:
    - Home: index.md
    - Introduction: introduction.md
    - Loading: loading.md
    - Supported Types: supported_types.md
  - Basic:
    - basic/index.md
    - Naming: basic/naming.md
    - Field Paths: basic/field-paths.md
    - Validation: basic/validation.md
    - Merging: basic/merging.md
    - Masking: basic/masking.md
    - Configure: basic/configure.md
    - CLI: basic/cli.md
  - Advanced:
    - advanced/index.md
    - Merging & Strategies:
      - Merge Strategies: advanced/merge-strategies.md
      - Field Groups: advanced/field-groups.md
      - Nested Resolve: advanced/nested-resolve.md
      - Skip Behaviors: advanced/skip-behaviors.md
    - Sources:
      - Config Search: advanced/config-search.md
      - CLI:
        - ArgparseSource: advanced/cli/argparse.md
        - Custom CLI Source: advanced/cli/custom.md
      - Remote:
        - VaultSource: advanced/remote/vault.md
        - Custom Remote Source: advanced/remote/custom.md
      - Custom Types: advanced/custom_types.md
      - Custom Sources: advanced/custom_sources.md
      - Cross-Source Refs: advanced/cross_source_refs.md
      - Conditional Sources: advanced/conditional_sources.md
    - Values:
      - ENV Expansion: advanced/env-expansion.md
      - Special Types: advanced/special-types.md
    - Observability:
      - Debug & Reports: advanced/debug.md
      - Caching: advanced/caching.md
  - Comparison:
    - vs pydantic-settings: comparison/why-not-pydantic-settings.md
    - vs Hydra: comparison/why-not-hydra.md
    - vs Dynaconf: comparison/why-not-dynaconf.md
    - Benchmarks: comparison/benchmarks.md
  - Reference:
    - API Reference: api-reference.md
    - Changelog: changelog.md

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - macros
  - git-revision-date-localized:
      enable_creation_date: true
      enable_git_follow: false
      fallback_to_build_date: true
      strict: false
  - social:
      enabled: !ENV [CI, false]
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true
      cache_safe: true
      css_files:
        - stylesheets/extra.css
  - llmstxt:
      full_output: llms-full.txt
      sections:
        Getting Started:
          - introduction.md
          - loading.md
          - supported_types.md
        Basic:
          - basic/index.md
          - basic/naming.md
          - basic/field-paths.md
          - basic/validation.md
          - basic/merging.md
          - basic/masking.md
          - basic/configure.md
          - basic/cli.md
        Advanced:
          - advanced/index.md
          - advanced/merge-strategies.md
          - advanced/field-groups.md
          - advanced/nested-resolve.md
          - advanced/skip-behaviors.md
          - advanced/config-search.md
          - advanced/cli/argparse.md
          - advanced/cli/custom.md
          - advanced/remote/vault.md
          - advanced/remote/custom.md
          - advanced/custom_types.md
          - advanced/custom_sources.md
          - advanced/cross_source_refs.md
          - advanced/conditional_sources.md
          - advanced/env-expansion.md
          - advanced/special-types.md
          - advanced/debug.md
          - advanced/caching.md
        Comparison:
          - comparison/why-not-pydantic-settings.md
          - comparison/why-not-hydra.md
          - comparison/why-not-dynaconf.md
          - comparison/benchmarks.md
        Reference:
          - api-reference.md
          - changelog.md

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascript/readthedocs.js

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets:
      base_path:
        - "."
  - pymdownx.mark
  - pymdownx.keys
  - pymdownx.tasklist:
      custom_checkbox: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: "#"
      toc_depth: 3