metamorphosis/mkdocs.yml at main · supportvectors/metamorphosis · 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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
site_name: SupportVectors MetaMorphosis
site_description: A simple example with AI Agents
site_author: SupportVectors
site_url: https://supportvectors.ai/metamorphosis

# -----------------------------------------------------------------------------
# Theme configuration
# -----------------------------------------------------------------------------
theme:
  name: material
  logo: images/overlapping_logo.png
  favicon: images/favicon.ico

  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: 'light blue'
      accent: 'gray'
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

  font:
    text: 'Lora'
    code: 'Roboto Mono'
    code_title: 'Roboto Mono'
    code_block: 'Roboto Mono'
    code_font_size: 0.9rem
    heading: 'Merriweather'
    heading_weight: 300
    heading_line_height: 1.5

# -----------------------------------------------------------------------------
# Plugins configuration
# -----------------------------------------------------------------------------

plugins:
  - search
  - mknotebooks:
      # Configure mknotebooks to avoid template deprecation warnings
      enable_default_jupyter_cell_styling: true
      execute: false
  - mkdocstrings:
      handlers:
        python:
          paths:
            - src
          options:
            show_source: true
  - awesome-pages
  - mermaid2
  - include-markdown:
      comments: false #This stops the include-markdown plugin comments from being displayed

markdown_extensions:
  - admonition
  - toc:
      permalink: true
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.superfences:
      # make exceptions to highlighting of code:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid

extra_css:
  - stylesheets/supportvectors.css

extra_javascript:
  - javascripts/mathjax.js
  #- https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
extra:
  PYTHONPATH: src

# -----------------------------------------------------------------------------
# Navigation structure
# -----------------------------------------------------------------------------
nav:
  - Home: index.md
  - Architecture: architecture.md
  - Package Documentation:
    - Overview: metamorphosis/index.md
    - MCP Package:
      - Overview: metamorphosis/mcp/index.md
      - TextModifiers: metamorphosis/mcp/TextModifiers.md
    - Agents Package:
      - Overview: metamorphosis/agents/index.md
      - Self Reviewer:
        - Overview: metamorphosis/agents/self_reviewer/index.md
    - Core Modules:
      - Data Models: metamorphosis/datamodel.md
      - Exceptions: metamorphosis/exceptions.md
      - Utilities: metamorphosis/utilities.md
      - Model Registry: metamorphosis/model_registry.md
      - Package Init: metamorphosis/init.md
  - Examples:
    - Overview: examples/index.md
    - Basic Processing:
      - Summarizer Usage: examples/summarizer_usage.md
      - Copy Editor Usage: examples/rationalize_usage.md
    - Advanced Processing:
      - Achievement Extraction: examples/extract_achievements_usage.md
      - Quality Evaluation: examples/review_text_evaluator_usage.md
    - Visualization:
      - Radar Charts: examples/visualize_evaluation_radar.md
  - Project Guide:
    - Tips & Tricks:
      - CUDA Issues: project-guide/tips-and-tricks/cuda-hell.md
    - Talk:
      - Outline: project-guide/talk-outline.md
      - Speaker Notes: project-guide/speaker-notes.md
      - Slides: project-guide/slides.md
  - Notebooks:
    - Common Patterns: notebooks/supportvectors-common.ipynb