patchpal/mkdocs.yml at main · amaiya/patchpal · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
site_name: PatchPal Documentation
site_description: An agentic coding and automation assistant, supporting both local and cloud LLMs
site_url: https://amaiya.github.io/patchpal/
repo_url: https://github.com/amaiya/patchpal
repo_name: amaiya/patchpal
edit_uri: edit/main/docs/

# Exclude the docs README (meta-documentation about building docs)
exclude_docs: |
  README.md

theme:
  name: material
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            members_order: source
            group_by_category: true
            show_if_no_docstring: false
            inherited_members: false
            merge_init_into_class: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - tables
  - attr_list
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started: getting-started/index.md
  - Features:
      - Built-In Tools: features/tools.md
      - Custom Tools: features/custom-tools.md
      - Skills System: features/skills.md
      - MCP Integration: features/mcp.md
      - Project Memory: features/memory.md
  - Model Configuration:
      - Overview: models/overview.md
      - Local Models: models/local-models.md
      - Offline Deployment: models/offline-deployment.md
  - Usage:
      - Interactive Usage: usage/interactive.md
      - Sandbox Mode: usage/sandbox.md
      - Python SDK: usage/python-api.md
      - Autopilot Mode: usage/autopilot.md
      - Example Tasks: usage/examples.md
  - Configuration: configuration.md
  - Safety: safety.md
  - Context Management: context-management.md
  - Troubleshooting: troubleshooting.md
  - API Reference:
      - Agent: reference/agent.md
      - Tools: reference/tools.md
      - Context Management: reference/context.md
      - Skills: reference/skills.md
      - Custom Tools: reference/custom-tools.md