mkdocs.yml

site_name: view.py
site_url: https://view.zintensity.dev
repo_url: https://github.com/ZeroIntensity/view.py
repo_name: ZeroIntensity/view.py

nav:
    - Home: index.md
    - Getting Started:
          - Installation: getting-started/installation.md
          - Configuration: getting-started/configuration.md
          - Creating a Project: getting-started/creating_a_project.md
    - Building Projects:
          - App Basics: building-projects/app_basics.md
          - URL Routing: building-projects/routing.md
          - Returning Responses: building-projects/responses.md
          - Taking Parameters: building-projects/parameters.md
          - Getting Request Data: building-projects/request_data.md
          - HTML Templating: building-projects/templating.md
          - Runtime Builds: building-projects/build_steps.md
          - Writing Documentation: building-projects/documenting.md
          - Using WebSockets: building-projects/websockets.md
    - API Reference:
          - Types: reference/types.md
          - Utilities: reference/utils.md
          - Exceptions: reference/exceptions.md
          - Applications: reference/app.md
          - Configuration: reference/config.md
          - Routing: reference/routing.md
          - Responses: reference/responses.md
          - Templates: reference/templates.md
          - Build: reference/build.md
          - WebSockets: reference/websockets.md
    - Contributing: contributing.md

theme:
    name: material
    palette:
        - media: "(prefers-color-scheme)"
          primary: blue
          accent: blue
          toggle:
              icon: material/brightness-auto
              name: Switch to light mode

        # Palette toggle for light mode
        - media: "(prefers-color-scheme: light)"
          scheme: default
          primary: blue
          accent: blue
          toggle:
              icon: material/brightness-7
              name: Switch to dark mode

        # Palette toggle for dark mode
        - media: "(prefers-color-scheme: dark)"
          scheme: slate
          primary: blue
          accent: blue
          toggle:
              icon: material/brightness-4
              name: Switch to system preference
    features:
        - content.tabs.link
        - content.code.copy
        - content.action.edit
        - search.highlight
        - search.share
        - search.suggest
        - navigation.footer
        - navigation.indexes
        - navigation.sections
        - navigation.tabs
        - navigation.tabs.sticky
        - navigation.top
        - toc.follow

    icon:
        repo: fontawesome/brands/github

extra:
    social:
        - icon: fontawesome/brands/discord
          link: https://discord.gg/tZAfuWAbm2
          name: view.py discord
        - icon: fontawesome/brands/github
          link: https://github.com/ZeroIntensity/view.py
          name: view.py repository
        - icon: material/heart
          link: https://github.com/sponsors/ZeroIntensity/
          name: support view.py

markdown_extensions:
    - toc:
          permalink: true
    - pymdownx.highlight:
          anchor_linenums: true
    - pymdownx.inlinehilite
    - pymdownx.snippets
    - admonition
    - pymdownx.details
    - pymdownx.tabbed:
          alternate_style: true
    - pymdownx.superfences

plugins:
    - search
    - tags
    - git-revision-date-localized:
          enable_creation_date: true
    - mkdocstrings:
          handlers:
              python:
                  paths: [src]
                  options:
                      show_root_heading: true
                      show_object_full_path: false
                      show_symbol_type_heading: true
                      show_symbol_type_toc: true
                      show_signature: true
                      seperate_signature: true
                      show_signature_annotations: true
                      signature_crossrefs: true
                      show_source: false
                      show_if_no_docstring: true
                      show_docstring_examples: false