mkdocs.yml

# Project Information
site_name: rite
site_url: https://www.pyrites.dev/
site_description: Python Utility Package
site_author: Scape Agency

# Directories
docs_dir: doc
site_dir: site

# Repository
repo_name: "GitHub"
repo_url: https://github.com/scape-agency/rite/
edit_uri_template: "docs/{path}"

dev_addr: 127.0.0.1:8888

# Copyright
copyright: >
  Copyright &copy; 2026 <a href="https://www.scape.agency">Scape Agency BV</a>. All Rights Reserved.

# hide:
#   - footer

# Configuration
theme:
  name: material
  custom_dir: "doc/overrides"
  locale: en
  language: en
  palette:
    scheme: scapeagency
  # palette:
  #   - scheme: default
  #     primary: indigo
  #     accent: indigo
  #     toggle:
  #       icon: material/brightness-7
  #       name: Switch to dark mode
  #   - scheme: slate
  #     primary: indigo
  #     accent: indigo
  #     toggle:
  #       icon: material/brightness-4
  #       name: Switch to light mode
  # Use text title only (no logo image); font is configured via extra.css
  # and extra_javascript.
  # font:
  #   text: 'STIX Two Text'
  #   code: 'JetBrains Mono'
  # Explicitly disable the Material logo so only the site_name
  # title ("rite") is shown in the header.
  logo: null
  favicon: assets/favicon/favicon.ico
  features:
    # - announce.dismiss
    # - content.action.edit
    # - content.action.view
    # - content.code.annotate
    # - content.code.copy
    # - content.tabs.link
    - content.tooltips
    # - header.autohide
    # - navigation.expand
    - navigation.footer
    - navigation.indexes
    # - navigation.instant
    # - navigation.prune
    # - navigation.sections
    # - navigation.tabs
    # - navigation.tabs.sticky
    # - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate

# Plugins
plugins:
  - search:
      lang: en
      separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            # Heading options
            heading_level: 2
            show_root_heading: false
            show_root_toc_entry: true
            show_root_full_path: false
            show_root_members_full_path: false
            show_object_full_path: false
            show_category_heading: true
            # Member options
            show_bases: true
            show_source: false
            show_signature: true
            show_signature_annotations: true
            separate_signature: false
            # Docstring options
            docstring_style: google
            docstring_section_style: table
            merge_init_into_class: true
            show_if_no_docstring: false
            # Additional options
            filters: ["!^_"]
            group_by_category: true
            show_submodules: true

# Customization
extra:
  generator: false
  analytics:
    provider: google
    property: G-49589BK5M9
  social:
    - icon: fontawesome/solid/globe
      link: https://www.scape.agency
    - icon: fontawesome/brands/github
      link: https://github.com/scape-agency/
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/scape-agency/
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/scape.agency/
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/scape.agency/
  # consent:
  #   title: Cookie consent
  #   description: >-
  #     We use cookies to recognize your repeated visits and preferences, as well
  #     as to measure the effectiveness of our documentation and whether users
  #     find what they're searching for. With your consent, you're helping us to
  #     make our documentation better.
extra_css:
  - assets/style/extra.css
extra_javascript:
  - assets/script/extra.js
extra_templates: []

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      repo_url_shorthand: true
      user: scape-agency
      repo: rite
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page tree
nav:
  - Home: "index.md"
  - Getting Started:
      - "Quick Start": "quick_start.md"
      - "Installation": "installation.md"
      - "Getting Started": "getting-started.md"
      - "Examples": "examples.md"
  - CLI: "cli.md"
  - API Reference:
    - "Overview": "api/index.md"
    - "Collections":
        - "Overview": "api/collections.md"
        - "Buffer": "api/collections/buffer.md"
        - "Cache": "api/collections/cache.md"
        - "Dict": "api/collections/dict.md"
        - "List": "api/collections/list.md"
        - "Pattern": "api/collections/pattern.md"
        - "Queue": "api/collections/queue.md"
        - "Set": "api/collections/set.md"
        - "Tree": "api/collections/tree.md"
    - "Conversion": "api/conversion.md"
    - "Crypto": "api/crypto.md"
    - "Diagnostics": "api/diagnostics.md"
    - "Filesystem": "api/filesystem.md"
    - "Functional": "api/functional.md"
    - "Markup": "api/markup.md"
    - "Net": "api/net.md"
    - "Numeric": "api/numeric.md"
    - "Reflection": "api/reflection.md"
    - "Serialization": "api/serialization.md"
    - "System": "api/system.md"
    - "Temporal": "api/temporal.md"
    - "Text": "api/text.md"
  - Development:
      - "Setup": "development/setup.md"
      - "Configuration": "development/configuration.md"
      - "Code Style": "development/code-style.md"
      - "Testing": "development/testing.md"
      - "AI Instructions": "development/ai-instructions.md"
      - "Build": "development/build.md"
  - Contributing: "contributing.md"
  - Resources:
      - "Glossary": "resources/glossary.md"
      - "Links": "resources/links.md"
  - About:
      - "Authors": "about/authors.md"
  - Legal:
      - "License": "legal/license.md"
      - "Privacy Policy": "legal/privacy_policy.md"
      - "Disclaimer": "legal/disclaimer.md"