RAG-Multimodal-Financial-Doc-Analysis-and-Recall/mkdocs.yml at main · Mattral/RAG-Multimodal-Financial-Doc-Analysis-and-Recall · 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
site_name: RAG Financial Multimodal
site_description: Enterprise-grade multimodal RAG for financial document analysis
site_author: RAG Financial Team
site_url: https://your-org.github.io/rag-financial-multimodal
repo_url: https://github.com/your-org/rag-financial-multimodal
repo_name: your-org/rag-financial-multimodal
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Dark mode
    - scheme: slate
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.share
    - content.code.annotate
    - content.code.copy
    - content.tabs.link
  icon:
    repo: fontawesome/brands/github

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

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

nav:
  - Home: index.md
  - Quickstart:
    - Local Setup: quickstart/local.md
    - Docker: quickstart/docker.md
    - First Query: quickstart/first-query.md
  - Architecture:
    - Overview: architecture/overview.md
    - Component Design: architecture/components.md
    - Data Flow: architecture/data-flow.md
    - ADRs:
      - "001: Hybrid Retrieval": adr/001-hybrid-retrieval-rrf.md
      - "002: Pydantic Config": adr/002-pydantic-v2-config.md
      - "003: Pluggable ABCs": adr/003-pluggable-components-abc.md
      - "004: PoT Sandbox": adr/004-program-of-thought-sandbox.md
  - Tutorials:
    - 10-K Analysis: tutorials/10k-analysis.md
    - Earnings QA: tutorials/earnings-qa.md
    - Multi-Tenant Setup: tutorials/multi-tenant.md
  - Configuration: configuration.md
  - API Reference:
    - REST API: api/rest.md
    - Python SDK: api/sdk.md
    - CLI: api/cli.md
  - Deployment:
    - Docker: deployment/docker.md
    - Kubernetes: deployment/kubernetes.md
    - Helm: deployment/helm.md
  - Security & Compliance: security.md
  - Evaluation: evaluation.md
  - Deep Dive: educational_deepdive.md
  - Contributing: contributing.md
  - Changelog: CHANGELOG.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/your-org/rag-financial-multimodal
  version:
    provider: mike