bt_api_py/mkdocs.yml at dev · cloudQuant/bt_api_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
site_name: bt_api_py
site_description: Evidence-bounded Python exchange API and forwarding runtime
site_author: cloudQuant
site_url: https://cloudquant.github.io/bt_api_py/
repo_name: cloudQuant/bt_api_py
repo_url: https://github.com/cloudQuant/bt_api_py
edit_uri: edit/dev/docs/
copyright: Copyright &copy; 2024 cloudQuant. MIT License.

theme:
  name: material
  language: zh
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
  features:
    - navigation.instant
    - navigation.instant.progress
    - navigation.tracking
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.code.copy
    - toc.follow
  icon:
    repo: fontawesome/brands/github
    logo: material/chart-line

plugins:
  - search:
      lang: [zh, en]
      separator: '[\s\-\.]+'
  - minify:
      minify_html: true
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [.]
          options:
            docstring_style: google
            show_root_heading: true
            show_source: false
            members_order: source

markdown_extensions:
  - admonition
  - attr_list
  - md_in_html
  - toc:
      permalink: true
      toc_depth: 3
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true

extra_css:
  - stylesheets/extra.css

nav:
  - 首页: index.md
  - 入门:
      - 安装与诊断: getting-started/installation.md
  - 使用:
      - BtApi 使用: guides/usage_guide.md
  - API 参考:
      - Core contract: reference/core-api.md
      - BtApi: reference/bt_api.md
  - 运行时:
      - 架构: explanation/architecture.md
      - Support status policy: operations/support-status-policy.md
      - Submodule validation: ci/submodule-validation-profiles.md

# Historical vendor manuals and old planning material remain in the checkout,
# but are excluded from the active site until they have current contract
# evidence and link validation.
exclude_docs: |
  acceptance/
  archive/
  architecture/
  decisions/
  exchanges/
  governance/
  plans/
  security/
  superpowers/
  迭代计划/
  AGENTS.md
  CODE_QUALITY.md
  MIGRATION_GUIDE.md
  SECURITY_COMPLIANCE.md
  code-quality-baseline.md
  development-guide.md
  project-overview.md
  project-structure-optimization.md
  release-checklist.md
  source-tree-analysis.md
  test-markers-guide.md
  getting-started/faq.md
  getting-started/quickstart.md
  examples/
  explanation/developer_guide.md
  explanation/exchange_integration_patterns.md
  explanation/multi_strategy_architecture.md
  guides/api-patterns.md
  guides/best_practices.md
  guides/error_handling.md
  guides/examples/
  guides/params.md
  guides/performance.md
  guides/security_best_practices.md
  guides/websocket-streaming.md
  reference/auth_config.md
  reference/data_containers.md
  reference/event_bus.md
  reference/exceptions.md
  reference/index.md
  reference/installation.md
  reference/registry.md
  reference/websocket.md
  operations/repository-release-checklist.md
  support/