TradeGraph/mkdocs.yml at master · ApexAILabs/TradeGraph · 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
site_name: TradeGraph Financial Advisor
site_description: AI-powered financial analysis and trading recommendations
site_author: TradeGraph Team
site_url: https://tradegraph.github.io/financial-advisor

repo_name: tradegraph/financial-advisor
repo_url: https://github.com/tradegraph/financial-advisor

theme:
  name: material
  palette:
    # Palette toggle for light mode
    - scheme: default
      primary: blue
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    # Palette toggle for dark mode
    - scheme: slate
      primary: blue
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.path
    - navigation.top
    - search.highlight
    - search.share
    - toc.follow
    - content.code.copy
    - content.code.select
    - content.tabs.link

plugins:
  - search
  - autorefs
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_toc_entry: false
            show_symbol_type_heading: true
            show_symbol_type_toc: true

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - CLI Usage: user-guide/cli.md
    - Python API: user-guide/python-api.md
    - Web Interface: user-guide/web-interface.md
    - Analysis Types: user-guide/analysis-types.md
  - API Reference:
    - Core Classes: api-reference/core.md
    - Agents: api-reference/agents.md
    - Models: api-reference/models.md
    - Services: api-reference/services.md
    - Workflows: api-reference/workflows.md
  - REST API:
    - Overview: rest-api/overview.md
    - Authentication: rest-api/authentication.md
    - Endpoints: rest-api/endpoints.md
    - WebSocket: rest-api/websocket.md
  - Examples:
    - Basic Usage: examples/basic.md
    - Advanced Usage: examples/advanced.md
    - Custom Agents: examples/custom-agents.md
    - Integration: examples/integration.md
  - Development:
    - Contributing: development/contributing.md
    - Testing: development/testing.md
    - Architecture: development/architecture.md
    - Deployment: development/deployment.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/tradegraph/financial-advisor
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/tradegraph-financial-advisor
  version:
    provider: mike