跳转至

API 参考

本页 API 文档由 mkdocstrings 从源码 docstring 自动抽取,无需手工同步。修改源码 docstring 后,mkdocs serve 会自动热重载页面。

约定

  • docstring 风格Google style
  • 类型注解:函数签名展示 Python type hints(mkdocs.ymlshow_signature_annotations: true
  • 私有成员:默认不展示(下划线开头方法),如需暴露请在源码中显式添加 __all__

模块索引

网格交易

持仓与执行

XtQuantManager

扩展抽取范围

mkdocs.yml nav 段添加新页面,在该页面写:

# 模块名
::: 模块导入路径

mkdocstrings 会自动渲染该模块的所有公开 class / function。