psynapse/mkdocs.yml at main · soumik12345/psynapse · 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
103
site_name: Psynapse
repo_name: soumik12345/psynapse
repo_url: https://github.com/soumik12345/psynapse
edit_uri: https://github.com/soumik12345/psynapse/tree/main/docs

theme:
  name: material
  icon:
    edit: material/pencil
  palette:
    - scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - content.code.annotate
    - content.code.copy
    - content.code.select
    - content.tabs.link
    - content.tooltips
    - navigation.tracking
    - navigation.expand
    - navigation.tabs

extra_javascript:
  - https://unpkg.com/mermaid@10/dist/mermaid.min.js
  - javascripts/mermaid-init.js

markdown_extensions:
  - attr_list
  - admonition
  # Code syntax highlighting with line numbers and anchors
  - pymdownx.highlight:
      # Adds anchors to line numbers
      anchor_linenums: true
      # Wraps lines in span elements
      line_spans: __span
      # Adds language class to code blocks
      pygments_lang_class: true
  # Enables inline code highlighting
  - pymdownx.inlinehilite
  # Allows including content from other files
  - pymdownx.snippets
  # Enables nested code blocks and custom fences
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_div_format
  # Adds support for callouts/notes/warnings
  - admonition
  # Enables collapsible blocks (expandable content)
  - pymdownx.details
  # Creates tabbed content (like installation examples)
  - pymdownx.tabbed:
      # Uses an alternative styling for tabs
      alternate_style: true

plugins:
  - search
  - panzoom
  - mkdocstrings:
      handlers:
        python:
          options:
            # Controls whether to show symbol types in the table of contents
            show_symbol_type_toc: true
            # Controls whether to show symbol type in the heading
            show_symbol_type_heading: true
            # Controls whether to show the root heading (module/class name)
            show_root_heading: true
            # Controls whether to show the source code
            show_source: false
            # Specifies the docstring style to parse (Google style in this case)
            docstring_style: google
            # Controls the order of members (by source order in this case)
            members_order: source
            # Controls whether to sort members alphabetically
            sort_members: false

nav:
  - Home: index.md
  - Guide:
    - Quick Start: guides/quick-start.md
    - Architecture: guides/architecture.md
    - Progress Nodes: guides/progress-nodes.md
    - Streaming Nodes: guides/stream-nodes.md
    - Annotated Dictionaries: guides/annotated-dicts.md
  - Examples:
    - LLM Examples: examples/llm.md
  - API Reference:
    - Backend:
      - Graph Executor: backend/executor.md
      - Schema Extractor: backend/schema_extractor.md
    - Frontend:
      - Components: frontend/components.md
      - Hooks: frontend/hooks.md
      - Utilities: frontend/utils.md
      - Types: frontend/types.md