fp-wraptr/mkdocs.yml at main · smkwray/fp-wraptr · 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
site_name: fp-wraptr
site_description: Python toolkit to modernize the Fair-Parke macroeconomic model workflow
site_url: https://smkwray.github.io/fp-wraptr/
repo_url: https://github.com/smkwray/fp-wraptr

theme:
  name: material
  logo: assets/logo.png
  favicon: assets/logo.png
  features:
    - content.code.copy
    - navigation.sections
    - navigation.expand
    - navigation.tabs
    - navigation.top
    - navigation.indexes
    - search.highlight
    - search.suggest
  palette:
    - scheme: default
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting Started:
    - Quickstart: quickstart.md
    - Architecture: architecture.md
  - Workflows:
    - Scenarios: scenarios.md
    - Data Update: data-update.md
    - Parity: parity.md
    - Stock FM Fast Mode: stock-fm-fast-mode.md
    - Dashboard: dashboard.md
    - Model Runs Export: model-runs.md
  - Agent & MCP:
    - Agent Workflows: agent-workflows.md
    - Pack Authoring: packs.md
    - MCP Server: mcp.md
    - MCP Tools: mcp-tools.md
  - Reference:
    - CLI: cli.md
    - Scenario YAML Schema: scenario-schema.md
    - Scenario DSL: dsl.md
    - fp.exe Commands: fp_exe_run_commands.md
    - API Reference: api.md
    - Changelog: changelog.md

exclude_docs: |
  ai-memory.md

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - pymdownx.details
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true