quantwave/mkdocs.yml at main · lavs9/quantwave · 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
site_name: QuantWave
site_url: https://lavs9.github.io/quantwave/
site_description: High-performance Rust + Polars quantitative finance library with 150+ indicators, full Ehlers DSP suite, and options pricing tools.
repo_name: lavs9/quantwave
repo_url: https://github.com/lavs9/quantwave

theme:
  name: material
  palette:
    - scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  features:
    - content.tabs.link
    - content.code.copy
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.top
    - navigation.path
    - search.suggest
    - search.highlight
    - toc.follow
  icon:
    logo: material/chart-timeline-variant
    favicon: material/chart-bell-curve-cumulative

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/lavs9/quantwave
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/quantwave/

nav:
  - Home: index.md
  - Purpose: purpose.md
  - Roadmap: roadmap.md
  - Benchmarks: benchmarks.md
  - Getting Started:
      - Python: getting-started/python.md
      - Rust: getting-started/rust.md
  - Guides:
      - Indicator Gallery: guides/indicators/gallery.md
      - Indicators: guides/indicators/
      - Backtest Engine:
          - Quickstart: guides/backtest/quickstart.md
          - Capability Matrix: guides/backtest/capability_matrix.md
      - Options India: guides/options_india.md
  - Examples:
      - Batch & Streaming: examples/batch-streaming.md
      - Marimo Notebooks:
          - Overview: examples/notebooks/index.md
          - Backtest Showcase: examples/notebooks/backtest_showcase.md
          - Backtest Benchmarks: examples/notebooks/backtest_benchmark.md
          - Strategy Backtest: examples/notebooks/strategy_backtest.md
          - PA Flag Breakout (E2E): examples/notebooks/pa_flag_breakout_strategy.md
          - Multi-Indicator Analysis: examples/notebooks/multi_indicator_analysis.md
          - ML Feature Stability: examples/notebooks/ml_feature_stability.md
          - ML Features → Backtest (E2E): examples/notebooks/ml_feature_backtest_parity.md
  - API Reference:
      - Python (package surface): api/
  - Community:
      - Contributing: contributing.md
      - Changelog: changelog.md
      - Documentation Decisions: DOCUMENTATION_DECISIONS.md

extra_css:
  - assets/indicator-badges.css

plugins:
  - search
  - marimo
  - git-revision-date-localized:
      enable_creation_date: true
      type: timeago
      fallback_to_build_date: true
      exclude:
        - api/*
        - examples/notebooks/*.py
        - examples/notebooks/*.md # marimo generated ones might match this
  - mkdocstrings:
      handlers:
        python:
          paths: ["quantwave-python/python"] # Adjusted to where python code is
          options:
            docstring_style: google
            show_source: false
  - gen-files:
      scripts:
        - docs/gen_python_api.py
  - literate-nav:
      nav_file: SUMMARY.md # Use SUMMARY.md for nav if present

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.details
  - pymdownx.tasklist
  - admonition
  - attr_list
  - md_in_html

extra_javascript:
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js