fincore/mkdocs.yml at master · cloudQuant/fincore · 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: fincore
site_description: Quantitative Performance & Risk Analytics for Python
site_url: https://cloudquant.github.io/fincore
repo_url: https://github.com/cloudQuant/fincore
repo_name: cloudQuant/fincore

theme:
  name: material
  language: zh
  palette:
    - scheme: default
      primary: indigo
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: indigo
      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.tabs.link

plugins:
  - search
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: numpy
            show_source: false
            show_root_heading: true
            show_symbol_type_heading: true
            members_order: source
            merge_init_into_class: true
            show_if_no_docstring: false

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
  - tables

docs_dir: mkdocs_docs

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Migration to 0.5: getting-started/migration.md
  - User Guide:
    - Domain model: guide/concepts.md
    - Portfolio reporting: guide/reporting.md
    - Visualization: guide/visualization.md
    - Portfolio Optimization: guide/optimization.md
    - Factor analysis: guide/factor-analysis.md
    - Factor research protocol: concepts/factor-research-protocol.md
    - Performance Return Semantics: guide/performance-semantics.md
    - Risk Validation: guide/risk-validation.md
    - Reproducible Research: guide/reproducible-research.md
    - Performance: guide/performance.md
  - API Reference:
    - Overview: api/index.md
    - Root namespace: api/fincore.md
    - fincore.metrics: api/metrics.md
    - fincore.performance: api/performance.md
    - fincore.portfolio: api/portfolio.md
    - fincore.report: api/report.md
    - fincore.factor_analysis: api/factor-analysis.md
    - fincore.runtime and extensions: api/runtime.md
    - fincore.viz: api/viz.md
    - fincore.optimization: api/optimization.md
    - fincore.simulation: api/simulation.md
    - fincore.attribution: api/attribution.md
    - fincore.risk: api/risk.md
  - Development:
    - Contributing: development/contributing.md
    - Development Guide: development/guide.md
    - API Stability: development/api-stability.md
    - Changelog: development/changelog.md
    - Release notes 0.5.1: development/releases/0.5.1.md
    - Release notes 0.5.0: development/releases/0.5.0.md
  - Ecosystem: ecosystem.md