python_tradingbot_framework/mkdocs.yml at main · JustinGuese/python_tradingbot_framework · 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
site_name: Trading Bot System Documentation
site_description: Automated trading bot system with technical analysis and portfolio management
site_author: Trading Bot Team

# Update these with your actual repository details
# repo_name: tradingbot25
# repo_url: https://github.com/yourusername/tradingbot25
# edit_uri: edit/main/docs/

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          paths: [tradingbot]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            merge_init_into_class: true
            show_signature_annotations: true

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

nav:
  - Home: index.md
  - Getting Started:
    - Quick Start: getting-started/quick-start.md
    - Installation: getting-started/installation.md
    - Creating a Bot: getting-started/creating-a-bot.md
  - Architecture:
    - Overview: architecture/overview.md
    - Bot Class System: architecture/bot-class-system.md
    - Database Models: architecture/database-models.md
  - API Reference:
    - Core Classes:
      - Bot: api/bot.md
      - DataService: api/data-service.md
      - PortfolioManager: api/portfolio-manager.md
      - BotRepository: api/bot-repository.md
      - AITools: api/aitools.md
    - Utilities:
      - Backtesting: api/backtest.md
      - Hyperparameter Tuning: api/hyperparameter-tuning.md
      - Helpers: api/helpers.md
      - Database: api/database.md
  - Deployment:
    - Overview: deployment/overview.md
    - Helm Charts: deployment/helm.md
    - Kubernetes: deployment/kubernetes.md
    - Documentation Deployment: DEPLOYMENT.md
  - Guides:
    - Technical Analysis: guides/technical-analysis.md
    - Portfolio Management: guides/portfolio-management.md
    - AI Tools: guides/ai-tools.md
    - Local Development: guides/local-development.md
  - Examples:
    - Example Bots: examples/example-bots.md