- 新增 MkDocs + Material 文档站(19 页):入门、CLI、场景示例、FAQ、 Contributing、Changelog、API 参考(mkdocstrings 自动渲染)、内部原理 (架构 / 协议 / 三池路由 / 缓存) - 新增 docs/llms.txt:面向 LLM 的结构化摘要(枚举取值、方法速查、常见陷阱) - 新增 scripts/check_docs.py:校验文档与 api.py 公开方法清单是否漂移 - 新增根 CHANGELOG.md 作为版本记录唯一来源,docs/changelog.md 用 snippet 引入 - 新增 .github/workflows/docs.yml:push main 自动构建并部署 GitHub Pages - 修正文档口径:TdxData 公开方法 53 个(51 数据方法 + start/close); API_REFERENCE 版本号 v0.3.2 -> v0.4.0 - pyproject.toml 新增 docs 依赖组;.gitignore 忽略 site/
34 lines
551 B
Plaintext
34 lines
551 B
Plaintext
# Python-generated files
|
||
__pycache__/
|
||
*.py[oc]
|
||
build/
|
||
dist/
|
||
wheels/
|
||
*.egg-info
|
||
.pytest_cache/
|
||
.ruff_cache/
|
||
|
||
# Virtual environments
|
||
.venv
|
||
|
||
# IDE / AI assistant data
|
||
.codebuddy/
|
||
.workbuddy/
|
||
|
||
# 代码图谱索引(本地生成)
|
||
.codegraph/
|
||
|
||
# 本地开发脚本与第三方源码归档(不随仓库发布)
|
||
examples/archive/
|
||
examples/pytdxwrapper_src/
|
||
examples/uvbuild_src/
|
||
|
||
# 根目录未使用的服务器清单副本(生效副本为 src/pytdxdata/servers.json)
|
||
/servers.json
|
||
|
||
# 仓库备份
|
||
_git_backup_*.bundle
|
||
|
||
# MkDocs 构建产物
|
||
site/
|