CNEquity/mkdocs.en.yml at main · 2017-Java/CNEquity · 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
# The English documentation site, built into site/en/ after the Chinese site:
#
#   mkdocs build --strict && mkdocs build --strict -f mkdocs.en.yml
#
# Everything not set here (markdown extensions, validation, theme features,
# shared overrides and CSS) comes from mkdocs.yml. docs/en/ is an independent
# page tree: its pages link only to each other.
INHERIT: mkdocs.yml

site_description: A daily-updated, traceable A-share research data lake
site_url: https://rootsunc.github.io/CNEquity/en/
edit_uri: edit/main/docs/en/
docs_dir: docs/en
site_dir: site/en
exclude_docs: ""

theme:
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to light mode

nav:
  - Home: index.md
  - Getting started:
      - Quick start: getting-started/quickstart.md
      - Installation and upgrades: getting-started/installation.md
      - Initialization, scope and resume: getting-started/initialization.md
      - Configuration reference: getting-started/configuration.md
  - Research and data:
      - Recipe index: recipes/README.md
      - Adjusted research baseline: recipes/research-baseline.md
      - PIT financial cross-sections: recipes/pit-rebalance.md
      - DuckDB and Polars: recipes/duckdb-polars.md
      - Commodity futures and options: recipes/derivatives.md
      - 15 / 30 / 60-minute bars: recipes/minute-bars-15-30-60.md
      - Dataset catalog: datasets/catalog.md
      - Query guide: datasets/query-guide.md
      - Fields and units: datasets/schema.md
      - Data contract: datasets/contract.md
      - Sources and history limits: datasets/sources.md
      - Universe profiles: reference/universe-profiles.md
  - Commands and API:
      - CLI by task: reference/cli.md
      - CLI options and defaults: reference/cli-options.md
      - Network and write inventory: reference/cli-surface.md
      - Python API: reference/python-api.md
      - MCP integration: reference/mcp.md
  - Operations:
      - Runbook: operations/runbook.md
      - Troubleshooting: operations/troubleshooting.md
      - Fetching and source protection: operations/fetch-policy.md
      - Source health: operations/source-health.md
      - Repository scripts: operations/scripts.md
      - Maintainer release checklist: operations/releasing.md
  - Product design:
      - Direction and boundaries: architecture/overview.md
      - Comparison with AKShare / Tushare: architecture/comparison.md
      - Design principles: architecture/design-principles.md
      - From ingestion to query: architecture/data-flow.md
      - Lake layout: architecture/lake-layout.md
  - Project and license:
      - Changelog: changelog.md
      - License, sources and citation: legal-and-data-sources.md