mkdocs.yml

site_name: pfun
site_description: Purely functional, Statically Typed Python
site_url: https://pfun.dev
repo_name: suned/pfun
repo_url: https://github.com/suned/pfun
edit_uri: ''
nav:
    - 'Guide':
        - What Is This?: what_is_this.md
        - Install: install.md
        - Immutable Objects And Data Structures: immutable_objects_and_data.md
        - Useful Functions: useful_functions.md
        - Effectful (But Side-Effect Free) Programming: effectful_but_side_effect_free.md
        - Curried And Type-Safe Operators: curried_and_typesafe_operators.md
        - Stack-Safety And Recursion: stack_safety.md
        - Property-Based Testing: property_based_testing.md
    - Other Resources: other_resources.md
    - 'API Reference':
        - 'pfun': pfun_api.md
        - 'pfun.functions': functions_api.md
        - 'pfun.effect': effect_api.md
        - 'pfun.schedule': schedule_api.md
        - 'pfun.state': state_api.md
        - 'pfun.console': console_api.md
        - 'pfun.files': files_api.md
        - 'pfun.clock': clock_api.md
        - 'pfun.random': random_api.md
        - 'pfun.logging': logging_api.md
        - 'pfun.subprocess': subprocess_api.md
        - 'pfun.http': http_api.md
        - 'pfun.sql': sql_api.md
        - 'pfun.list': list_api.md
        - 'pfun.dict': dict_api.md
        - 'pfun.maybe': maybe_api.md
        - 'pfun.either': either_api.md
        - 'pfun.immutable': immutable_api.md
        - 'pfun.trampoline': trampoline_api.md
        - 'pfun.hypothesis_strategies': hypothesis_strategies_api.md
        - 'pfun.operator': operator_api.md
        - 'pfun.lens': lens_api.md
theme:
    name: material
    palette:
        primary: blue
    logo: nav_logo.svg
    favicon: nav_logo.svg
    custom_dir: docs/overrides
markdown_extensions:
    - codehilite
    - admonition
plugins:
    - search
    - mkdocstrings:
        custom_templates: docs/templates
        handlers:
            python:
              rendering:
                show_source: false
                show_root_heading: true
        watch:
            - src/pfun