project-x-py/mkdocs.yml at main · TexasCoding/project-x-py · 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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
site_name: ProjectX Python SDK
site_description: High-performance async Python SDK for futures trading
site_url: https://github.com/TexasCoding/project-x-py
site_author: TexasCoding

repo_name: TexasCoding/project-x-py
repo_url: https://github.com/TexasCoding/project-x-py
edit_uri: edit/main/docs/

theme:
  name: material
  language: en
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - content.code.annotate
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    code: Roboto Mono
  icon:
    repo: fontawesome/brands/github

plugins:
  - search:
      separator: '[\s\-\.]'
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_root_heading: true
            show_root_toc_entry: true
            show_signature_annotations: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true
            docstring_style: google
            docstring_section_style: list
            merge_init_into_class: true
            separate_signature: true
            show_bases: true
  - mkdocs-jupyter:
      include_source: true
      execute: false
      include_requirejs: true

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - admonition
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Authentication: getting-started/authentication.md
    - Configuration: getting-started/configuration.md
  - User Guide:
    - Trading Suite: guide/trading-suite.md
    - Order Management: guide/orders.md
    - Position Tracking: guide/positions.md
    - Real-time Data: guide/realtime.md
    - Technical Indicators: guide/indicators.md
    - Risk Management: guide/risk.md
    - Order Book: guide/orderbook.md
    - Trading Sessions: guide/sessions.md
  - API Reference:
    - Client: api/client.md
    - Trading Suite: api/trading-suite.md
    - Order Manager: api/order-manager.md
    - Position Manager: api/position-manager.md
    - Data Manager: api/data-manager.md
    - Statistics & Analytics: api/statistics.md
    - Indicators: api/indicators.md
    - Models: api/models.md
  - Examples:
    - Basic Usage: examples/basic.md
    - Advanced Trading: examples/advanced.md
    - Multi-Instrument Trading: examples/multi-instrument.md
    - Real-time Data: examples/realtime.md
    - Backtesting: examples/backtesting.md
    - Notebooks: examples/notebooks/index.md
  - Development:
    - Contributing: development/contributing.md
    - Testing: development/testing.md
    - Agents: development/agents.md
    - Architecture: development/architecture.md
  - Migration:
    - v3 to v4: migration/v3-to-v4.md
    - Breaking Changes: migration/breaking-changes.md
  - Changelog: changelog.md

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/TexasCoding
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/project-x-py/
  version:
    provider: mike
    default: stable

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

copyright: Copyright &copy; 2024-2025 TexasCoding