Este archivo es para desarrollo y mantenimiento: enumera los módulos de origen y los destinos de la documentación para las API exportadas de nivel superior en qteasy/__init__.py::__all__, lo que facilita la realización de una auditoría global de coherencia de la documentación de la API.

Nota: Este archivo no se utiliza como punto de entrada para el tutorial del usuario (no aparecerá automáticamente en el TOC de Sphinx); es sólo para mantenimiento dentro del repositorio.

1. 顶层导出(按 __all__ 分类)

1.1 Puntos de entrada de inicio/ejecución (núcleo/configuración)

  • run (qteasy/core.py): punto de entrada de ejecución unificada (backtesting/optimización/comercio en vivo, etc.)

  • is_ready (qteasy/core.py): verifique los requisitos previos del tiempo de ejecución

  • info (qteasy/core.py): punto de entrada de ayuda/información (aún no implementado)

  • configure (qteasy/configure.py): punto de entrada de configuración

  • set_config (qteasy/configure.py): alias de configuración

  • configuration / get_config / get_configurations (qteasy/configure.py): ver configuración

  • save_config / load_config / reset_config / view_config_files (qteasy/configure.py): archivos de configuración y reinicio

  • start_up_settings / update_start_up_setting / remove_start_up_setting / get_start_up_settings (qteasy/configure.py): mantenimiento de la configuración de inicio

  • start_up_config (qteasy/__init__.py): resultado del análisis de la configuración de inicio (constante)

Entrada de documentación correspondiente:

  • docs/source/api/use_qteasy.rst (Inicio y ejecución)

  • docs/source/api/api_reference.rst (Configuración y Referencia)

1.2 Recuperación/descripción general de datos (básico)

  • get_basic_info / get_stock_info (qteasy/core.py)

  • get_data_overview / refill_data_source (qteasy/core.py)

  • get_history_data / get_kline (qteasy/core.py)

  • filter_stock_codes / filter_stocks (qteasy/core.py)

  • get_table_info / get_table_overview (qteasy/core.py)

Entrada de documentación correspondiente:

  • docs/source/api/history_data.rst

  • docs/source/references/2-get-history-data.md

1.3 Contenedor de investigación (historia)

  • HistoryPanel (qteasy/history.py)

  • dataframe_to_hp / stack_dataframes (qteasy/history.py)

Entrada de documentación correspondiente:

  • docs/source/api/HistoryPanel.rst

  • docs/source/tutorials/2.5-historypanel-data-analysis.md (incluye §9–§11: investigación → migración de prueba retrospectiva, unión de paneles de múltiples fuentes, exportación a modelos de estadísticas)

  • docs/source/design/10-historypanel-factor-research-layer.md (evaluación de capa de FactorResearch opcional)

  • Ejemplos: ⟦CÓDIGO0⟧, ⟦CÓDIGO1⟧, ⟦CÓDIGO2⟧

1.4 Estrategias y operadores (operador/estrategia/integrado)

  • Operator (qteasy/qt_operator.py)

  • BaseStrategy / RuleIterator / GeneralStg / FactorSorter (qteasy/strategy.py)

  • built_ins / built_in_list / built_in_strategies / get_built_in_strategy (qteasy/built_in.py)

Entrada de documentación correspondiente:

  • docs/source/api/Operators.rst

  • docs/source/api/Strategies.rst

  • docs/source/api/built_in_strategies.rst

1.5 Fuentes de datos y tipos de datos (base de datos/tipos de datos)

  • DataSource (qteasy/database.py)

  • DataType / StgData / find_history_data (qteasy/datatypes.py)

Entrada de documentación correspondiente:

  • docs/source/api/data_source.rst

  • docs/source/api/data_types.rst

1.6 Visualización y Costos (visual/financiero)

  • candle (qteasy/visual.py)

  • CashPlan / set_cost / update_cost (qteasy/finance.py)

Entrada de documentación correspondiente:

  • docs/source/api/use_qteasy.rst (punto de entrada)

1.7 Constantes y objetos globales (init)

  • Constantes de modo: LIVE_MODE / BACKTEST_MODE / OPTIMIZE_MODE / PREDICT_MODE y alias

  • Rutas y objetos: QT_ROOT_PATH / QT_SYS_LOG_PATH / QT_TRADE_LOG_PATH / QT_CONFIG / QT_DATA_SOURCE / logger_core

  • Versión: ⟦CÓDIGO0⟧ / ⟦CÓDIGO1⟧

Entrada de documentación correspondiente:

  • docs/source/api/use_qteasy.rst (referencia rápida para modos de ejecución y constantes)