Files
pytdxdata/mkdocs.yml
T
openbot-coder 1bee6b0fc7 release: v0.5.0(文档站 + README 瘦身 + AI 助手技能)
新增
- 文档站(MkDocs + Material + mkdocstrings),push main 自动构建并部署 GitHub Pages
- SKILL.md:面向 AI 编程助手的技能文件(三条必守约定 / 枚举取值表 / 任务→方法决策表 / 9 条陷阱)
- docs/ai.md:文档站的「AI 助手接入」页
- tests/test_check_docs.py(10 项):漂移检查器自身的自测

变更
- README 361 → 125 行,只保留入口层;CLI 手册 / API 表 / 通道路由 / 架构树 /
  扩展市场 / easy-tdx 对比 / Changelog 全部移交文档站与 CHANGELOG.md
- README 相对链接改为绝对 URL(PyPI 渲染不重写相对链接,原本在 PyPI 页面全 404)
- check_docs.py 扩展为两档:MUST_LIST_ALL(须列全)+ MUST_NOT_BE_STALE(只需无过时引用),
  并把 SKILL.md / README / llms.txt / 教程类页面纳入;白名单放行 config 的模块级函数
- 版本号 0.4.0 → 0.5.0;包元数据 Documentation 指向文档站
- uv.lock 同步

修复
- ExMarket 成员数 52 → 46(实测 IntEnum 成员数),4 处文档同步更正
- docs/ai.md 的 3 处相对链接 + CHANGELOG 的 SKILL.md 链接(会导致 mkdocs --strict 失败)
- README 标注的测试数量 85 → 109(pytest 实际收集用例数)
2026-09-15 14:55:07 +08:00

142 lines
3.9 KiB
YAML

site_name: pytdxdata
site_description: >-
通达信(TongDaXin)行情数据客户端 — 动态连接池 + 双层TTL缓存 + 3连接并发分页,
纯 asyncio 零运行时依赖,支持 A股/港股/美股/期货/期权
site_url: https://openbot-coder.github.io/pytdxdata/
site_author: openbot-coder
repo_url: https://github.com/openbot-coder/pytdxdata
repo_name: openbot-coder/pytdxdata
edit_uri: edit/main/docs/
copyright: MIT License · 仅供技术研究与教育用途,不构成任何投资建议
theme:
name: material
language: zh
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
toggle:
icon: material/weather-night
name: 切换到深色模式
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/weather-sunny
name: 切换到浅色模式
features:
- navigation.instant
- navigation.instant.progress
- navigation.tracking
- navigation.sections
- navigation.indexes
- navigation.top
- navigation.footer
- toc.follow
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
- content.action.edit
- content.tabs.link
icon:
repo: fontawesome/brands/github
nav:
- 首页: index.md
- 快速开始:
- 安装与配置: getting-started.md
- 场景示例: cookbook.md
- 命令行工具: cli.md
- API 参考:
- 接口总览: api/index.md
- TdxData 方法: api/tdxdata.md
- 枚举速查: api/enums.md
- 数据模型: api/models.md
- 技术指标: api/indicator.md
- 文件解析器: api/codec.md
- 完整接口清单: API_REFERENCE.md
- 深入原理:
- 架构总览: internals/architecture.md
- 协议与命令: internals/protocol.md
- 通道与数据源: internals/routing.md
- 连接池与缓存: internals/cache-pool.md
- AI 助手接入: ai.md
- 其他:
- 常见问题: faq.md
- 更新日志: changelog.md
- 参与贡献: contributing.md
plugins:
- search:
lang:
- zh
- en
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [src]
options:
docstring_style: google
docstring_section_style: list
show_source: false
show_root_heading: true
show_root_toc_entry: true
show_symbol_type_heading: true
show_symbol_type_toc: true
members_order: source
group_by_category: true
show_category_heading: true
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
merge_init_into_class: true
filters:
- "!^_"
- "!^__"
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- footnotes
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- toc:
permalink: true
toc_depth: 3
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
- pymdownx.details
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ["."]
check_paths: true
restrict_base_path: false
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/openbot-coder/pytdxdata
name: GitHub 仓库
- icon: fontawesome/brands/python
link: https://pypi.org/project/pytdxdata/
name: PyPI
generator: false