jquantstats/mkdocs.yml at main · Jebel-Quant/jquantstats · 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
INHERIT: docs/mkdocs-base.yml

site_name: jquantstats
site_description: Portfolio analytics for quants – built on Polars, powered by Plotly.
site_author: Jebel Quant Research
site_url: https://jebel-quant.github.io/jquantstats/
repo_url: https://github.com/jebel-quant/jquantstats
repo_name: jebel-quant/jquantstats
copyright: Copyright &copy; 2024–2026 Jebel Quant Research

nav:
  - Home: index.md
  - Getting Started: getting_started.md
  - Guides:
    - Cost Models: cost_models.md
    - Migration from QuantStats: MIGRATION.md
    - QuantStats Parity Benchmark: benchmark.md
  - API Reference: api.md
  - Reference:
    - API Stability: STABILITY.md
  - Notebooks:
    - Analytics Demo: notebooks/analytics_demo.html
    - Plots and Reports: notebooks/plots_and_reports.html
  - Reports:
    - Test Report: reports/html-report/report.html
    - Coverage Report: reports/html-coverage/index.html

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/jebel-quant/jquantstats

theme:
  icon:
    logo: material/chart-line

plugins:
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
          options:
            docstring_style: google
            show_source: true
            show_root_heading: true
            show_symbol_type_heading: true
            show_symbol_type_toc: true