EasyQuant/mkdocs.yml at main · AlanFokCo/EasyQuant · 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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
site_name: EasyQuant
site_description: EasyQuant / eqlib — 中国 A 股事件驱动回测框架
site_url: https://AlanFokCo.github.io/EasyQuant
repo_url: https://github.com/AlanFokCo/EasyQuant
repo_name: AlanFokCo/EasyQuant
docs_dir: docs
copyright: Copyright &copy; AlanFokCo · MIT License
theme:
  name: material
  custom_dir: docs/overrides
  logo: assets/logo-icon.svg
  favicon: assets/logo-icon.svg
  font:
    text: "Noto Sans SC"
    code: "JetBrains Mono"
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.indexes
    - navigation.top
    - navigation.footer
    - toc.follow
    - search.highlight
    - search.suggest
    - search.share
    - content.code.copy
    - content.tooltips
  palette:
    - scheme: slate
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-4
        name: 切换浅色模式
    - scheme: default
      primary: custom
      accent: custom
      toggle:
        icon: material/brightness-7
        name: 切换深色模式
extra:
  homepage: https://AlanFokCo.github.io/EasyQuant
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/AlanFokCo/EasyQuant
      name: GitHub
extra_css:
  - assets/stylesheets/extra.css
plugins:
  - i18n:
      docs_structure: suffix
      languages:
        - locale: zh
          name: 中文
          default: true
          build: true
        - locale: en
          name: English
          build: true
          nav_translations:
            教程: Tutorials
            操作指南: How-to Guides
            API 参考: API Reference
            概念解释: Explanation
            示例: Examples
            项目: Project
            前置知识: Prerequisites
            常见问题: FAQ
            更新日志: Changelog
            贡献指南: Contributing
            安全政策: Security
            Web 策略工作室: Web Studio
            Home: Home
            GitHub: GitHub
  - search:
      lang:
        - zh
        - en
  - git-revision-date-localized:
      enable_creation_date: true
      fallback_to_build_date: true
      enable_parallel_processing: false
markdown_extensions:
  - admonition
  - attr_list
  - codehilite
  - md_in_html
  - tables
  - toc:
      permalink: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.details
  - pymdownx.betterem
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      base_path: ["."]
  - def_list
nav:
  - Home: index.md

  - 教程:
      - tutorials/index.md
      - 前置知识:
          - tutorials/prerequisites/index.md
          - tutorials/prerequisites/python-basics.md
          - tutorials/prerequisites/technical-concepts.md
          - tutorials/prerequisites/ashare-knowledge.md
      - "00 · 入门": tutorials/00-getting-started.md
      - "01 · 首个策略": tutorials/01-first-strategy.md
      - "02 · 回测": tutorials/02-backtesting.md
      - "03 · 优化": tutorials/03-optimization.md
      - "04 · 实盘": tutorials/04-live-trading.md
      - "05 · RSI 均值回归": tutorials/05-rsi-mean-reversion.md
      - "06 · 行业轮动": tutorials/06-sector-rotation.md
      - "07 · 多因子": tutorials/07-multi-factor.md
      - "08 · 综合策略": tutorials/08-combined-strategy.md
      - "09 · 参数优化": tutorials/09-param-optimization.md
      - "10 · A股数据": tutorials/10-ashare-data-risk.md
      - "11 · 机器学习选股": tutorials/11-ml-selection.md

  - 操作指南:
      - how-to/index.md
      - how-to/install.md
      - how-to/write-strategy.md
      - how-to/manage-positions.md
      - how-to/fetch-data.md
      - how-to/use-utilities.md
      - how-to/run-backtest.md
      - how-to/read-reports.md
      - how-to/paper-trade.md
      - how-to/selection-strategy.md
      - how-to/portfolio-risk.md
      - how-to/param-optimization.md
      - Web 策略工作室:
          - how-to/web-studio.md
          - how-to/deploy-web-studio.md
      - how-to/export-ptrade.md

  - API 参考:
      - reference/index.md
      - reference/structures.md
      - reference/api-trading.md
      - reference/api-data.md
      - reference/api-backtest.md
      - reference/api-config.md
      - reference/api-analysis.md
      - reference/api-selection.md
      - reference/api-risk.md
      - reference/api-scientific.md
      - reference/api-notification.md
      - reference/utils.md
      - reference/reports-format.md
      - reference/api-ml.md

  - 概念解释:
      - explanation/index.md
      - explanation/architecture.md
      - explanation/backtest-model.md
      - explanation/ashare-market.md
      - explanation/glossary.md

  - 示例: examples/index.md

  - 项目:
      - project/faq.md
      - project/changelog.md
      - project/contributing.md
      - project/security.md

  - GitHub: https://github.com/AlanFokCo/EasyQuant