This file is for development and maintenance: it lists the source modules and documentation destinations for the top-level exported APIs in qteasy/__init__.py::__all__, making it easier to conduct a global API documentation consistency audit.

Note: This file is not used as an entry point for the user tutorial (it will not automatically appear in the Sphinx TOC); it is only for maintenance within the repository.

1. 顶层导出（按 __all__ 分类）

1.1 Startup/Run entry points (core / configure)

  • run (qteasy/core.py): unified run entry point (backtesting/optimization/live trading, etc.)

  • is_ready (qteasy/core.py): check runtime prerequisites

  • info (qteasy/core.py): help/info entry point (not implemented yet)

  • configure (qteasy/configure.py): configuration entry point

  • set_config (qteasy/configure.py): configuration aliases

  • configuration / get_config / get_configurations (qteasy/configure.py): view configuration

  • save_config / load_config / reset_config / view_config_files (qteasy/configure.py): config files and reset

  • start_up_settings / update_start_up_setting / remove_start_up_setting / get_start_up_settings (qteasy/configure.py): startup configuration maintenance

  • start_up_config (qteasy/__init__.py): startup configuration parsing result (constant)

Corresponding documentation entry:

  • docs/source/api/use_qteasy.rst (Startup and Running)

  • docs/source/api/api_reference.rst (Configuration and Reference)

1.2 Data retrieval/overview (core)

  • 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)

Corresponding documentation entry:

  • docs/source/api/history_data.rst

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

1.3 Research container (history)

  • HistoryPanel (qteasy/history.py)

  • dataframe_to_hp / stack_dataframes (qteasy/history.py)

Corresponding documentation entry:

  • docs/source/api/HistoryPanel.rst

  • docs/source/tutorials/2.5-historypanel-data-analysis.md (includes §9–§11: research → backtest migration, multi-source panel stitching, exporting to statsmodels)

  • docs/source/design/10-historypanel-factor-research-layer.md (optional FactorResearch layer evaluation)

  • Examples: examples/historypanel_research_to_strategy.py, examples/historypanel_multisource_research.py, examples/historypanel_statsmodels_export.py

1.4 Strategies and operators (operator / strategy / built_in)

  • 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)

Corresponding documentation entry:

  • docs/source/api/Operators.rst

  • docs/source/api/Strategies.rst

  • docs/source/api/built_in_strategies.rst

1.5 Data Sources and Data Types (database / datatypes)

  • DataSource (qteasy/database.py)

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

Corresponding documentation entry:

  • docs/source/api/data_source.rst

  • docs/source/api/data_types.rst

1.6 Visualization and Costs (visual / finance)

  • candle (qteasy/visual.py)

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

Corresponding documentation entry:

  • docs/source/api/use_qteasy.rst (entry point)

1.7 Constants and Global Objects (init)

  • Mode constants: LIVE_MODE / BACKTEST_MODE / OPTIMIZE_MODE / PREDICT_MODE and aliases

  • Paths and objects: QT_ROOT_PATH / QT_SYS_LOG_PATH / QT_TRADE_LOG_PATH / QT_CONFIG / QT_DATA_SOURCE / logger_core

  • Version: __version__ / version_info

Corresponding documentation entry:

  • docs/source/api/use_qteasy.rst (quick reference for run modes and constants)