tradelens/mkdocs.yml at main · uppusaikiran/tradelens · 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
site_name: TradeLens Documentation
site_description: Documentation for the TradeLens AI-powered stock portfolio analysis tool
site_author: TradeLens Team
repo_url: https://github.com/yourusername/tradelens
edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    primary: indigo
    accent: blue
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.expand
    - navigation.indexes
    - content.code.copy
    - content.tabs.link

nav:
  - Home: index.md
  - User Guide:
    - user_guide/index.md
    - Getting Started: user_guide/getting_started.md
    - Dashboard Overview: user_guide/dashboard.md
    - Portfolio Analysis: user_guide/portfolio_analysis.md
    - AI-Powered Features: user_guide/ai_features.md
    - Earnings Analysis: user_guide/earnings_analysis.md
    - Risk Assessment: user_guide/risk_assessment.md
    - Strategy Backtesting: user_guide/strategy_backtesting.md
    - Event Risk Calendar: user_guide/event_risk_calendar.md
    - Settings and Configuration: user_guide/settings.md
    - FAQ: user_guide/faq.md
  - API Documentation: api/index.md
  - Database Schema: database/schema.md
  - Development Guide:
    - development/index.md
    - Project Structure: development/project_structure.md
    - Environment Setup: development/environment_setup.md
    - Coding Standards: development/coding_standards.md
    - Testing Guidelines: development/testing.md
    - AI Integration: development/ai_integration.md
    - Contributing Guidelines: development/contributing.md
  - Deployment Guide: deployment/index.md

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.tasklist:
      custom_checkbox: true
  - toc:
      permalink: true

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            show_source: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/yourusername/tradelens

extra_css:
  - css/extra.css